Comments (8)
I don’t see any “readme field” in your package.json.
It's because it no longer works.
Exactly. We've since abandoned that workaround.
The trick I used is to add a README.md in addition to our README.adoc
I've found this approach to be very unreliable. Sometimes it prefers the README.adoc over the README.md, which gets us back to the initial problem of a blank README on npmjs.com.
I actually think there are two problems here. The first problem is lack of support for README.adoc on npmjs.com. The other problem is that fact that you can't specify which file to use as the README when packaging. I really dislike this guessing logic.
The workaround I came up with is still very tenuous. It assumes a lot about the order of operations when packaging. And I've found that when I use lerna or yarn to publish, I have to use a different sequence. It makes publishing packages way more complicated than it has to be because we can't rely on most of the publishing tools available (or can't use them without applying workarounds that are likely to break).
In the most recent package I published, I ended up just reverting to a bash script because I got tired of wasting time trying to conjure up a solution. See https://gitlab.com/antora/expand-path-helper/blob/master/npm/release.sh.
Can we please start discussing real solutions? I'm willing to help in anyway that I can.
from www.
I don’t see any “readme field” in your package.json.
It's because it no longer works. See #136.
The trick I used is to add a README.md
in addition to our README.adoc
: https://github.com/asciidoctor/asciidoctor-reveal.js/blob/master/README.md
I haven't discovered this, this guy did. Not sure what GitHub's heuristic is to know which to display but my guess is that they display the largest one.
@mojavelinux found another way that you might prefer.
from www.
relevant: https://github.com/github/markup#markups
from www.
Thanks for the suggestion! We've passed this on to our product team.
from www.
+1
from www.
Many thumbs up for Asciidoctor
support
from www.
It’s a shame that npmjs.com still does not support anything but Markdown.
@obilodeau How did you managed to put that text “Please see the project home page for the README …” on asciidoctor-reveal.js npm page? I don’t see any “readme field” in your package.json.
from www.
I want to point out that there is an AsciiDoc processor available for Node. It's not a matter of finding the software. It's just a matter of deciding when it should be called.
https://yarnpkg.com/en/package/asciidoctor.js
from www.
Related Issues (20)
- the image in the README is displayed beyond the screen HOT 1
- how can we close Solr Connection once it open
- Readability issues with new code block font HOT 2
- Readmes missing after publishing a new package HOT 6
- "@" in the install instruction is cut off
- unexpected status code from user-acl: 500 when trying to create a new account
- NPM Package UI (CSS) Breaking For My Package
- problem with rtl
- Links in h1 titles in packages' README files are hidden
- npmjs.org always assumes that all dependencies are on npmjs.org and ends up linking to unrelated packages. HOT 1
- Not able to install via npm
- Package search shows wrong date and version
- Index out of bounds exception when navigating to a member page past maximum
- Wrong documentation last modified date in docs.npmjs.com (October 26, 1985)
- Search result shows old version HOT 1
- 2fa recovery codes truncated HOT 1
- Provide links for specific tags at the top of the package details page (Readme, admin, dependencies, etc)
- Home page link url is incorrect HOT 2
- Repository link url is broken HOT 1
- Searchbar for @scoped packages
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from www.