Comments (26)
🎉
from nodejs-cli-apps-best-practices.
The existing bug of gitlocalize can be circumvented by directly displaying the details. I think it is helpful to add TL;DR.
from nodejs-cli-apps-best-practices.
Sounds good, I'll plan for both of these updates then 👌
from nodejs-cli-apps-best-practices.
Great!👏
from nodejs-cli-apps-best-practices.
Will you consider building a documentation website?
from nodejs-cli-apps-best-practices.
I'm open to do that if someone wants to suggest pushing a docs directory for it and then we can also easily host it on GitHub Pages.
from nodejs-cli-apps-best-practices.
Yeah, it's great! I've been working on a vuepress theme recently. what tools are you going to use?
from nodejs-cli-apps-best-practices.
Didn't have anything in mind so whichever works and Vuepress is fine with me. Will it handle the current markdown style we have on the README though?
from nodejs-cli-apps-best-practices.
It can be handled. Vuepress makes people focus on writing documents.
from nodejs-cli-apps-best-practices.
Can you provide an example of a markdown type of README page and how does the vuepress visuals of it look like?
from nodejs-cli-apps-best-practices.
This is the effect of the default theme:
example:https://vuepress.vuejs.org/
source:https://github.com/vuejs/vuepress/blob/master/packages/docs/docs/README.md
from nodejs-cli-apps-best-practices.
If you can put up a quick example of how the README would look like that would be great. I was hoping for some kind of layout where the table of contents would be on the left, and the right would have the actual content and so navigation will be really easy.
from nodejs-cli-apps-best-practices.
I am still developing such a theme, maybe https://v2.docusaurus.io/ is more suitable
from nodejs-cli-apps-best-practices.
That's ok. Not super important and we'll get to it later on is just fine.
from nodejs-cli-apps-best-practices.
👌
from nodejs-cli-apps-best-practices.
@all-contributors please add @vvni for translation
from nodejs-cli-apps-best-practices.
I've put up a pull request to add @vvni! 🎉
from nodejs-cli-apps-best-practices.
@all-contributors please add @terkelg @jasonkarns for content
@all-contributors please add @davesag for maintenance
from nodejs-cli-apps-best-practices.
I could not determine your intention.
Basic usage: @all-contributors please add @Someone for code, doc and infra
For other usages see the documentation
from nodejs-cli-apps-best-practices.
@all-contributors please add @terkelg @jasonkarns for content
from nodejs-cli-apps-best-practices.
I've put up a pull request to add @terkelg! 🎉
from nodejs-cli-apps-best-practices.
@all-contributors please add @jasonkarns for content
from nodejs-cli-apps-best-practices.
I've put up a pull request to add @jasonkarns! 🎉
from nodejs-cli-apps-best-practices.
@all-contributors please add @davesag for maintenance
from nodejs-cli-apps-best-practices.
I've put up a pull request to add @davesag! 🎉
from nodejs-cli-apps-best-practices.
I'll figure out the spacing later.
I think can close the issue for now
from nodejs-cli-apps-best-practices.
Related Issues (20)
- How to perform user authentication in CLI? HOT 6
- Idea: add a section for CLI tools
- Updates needed for up to date Node.js runtime features
- Do you have plans to translate it into other languages? HOT 1
- New Practice: Distinguish STDOUT from STDERR
- Caveat: Accept STDIN somewhat counter to Empathetic CLI HOT 1
- [author required] New Practice: Support shell completion HOT 7
- Request: New experience best practice request: i18n HOT 2
- New Distribution Practice: Exclude unnesessary files from npm publish HOT 5
- GitLocalize: Problems with the structure of the .md file HOT 5
- Upgrade severals examples from require to import. HOT 1
- New Experience best practice request: version information HOT 7
- New feature: document other CLI related resources HOT 5
- New feature: document a new section for popular command line frameworks HOT 7
- Cleanup configuration files (if any) when uninstalling the package HOT 5
- Add the Crowdin internationalization integration tool to the project HOT 15
- remove 2.3 Cleanup configuration files chapter as it does not work since npm v7 HOT 2
- Can I use GitLocalize to translate documents? HOT 9
- Good first issue: add Crowdin badge to the repository
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 nodejs-cli-apps-best-practices.