-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
zuofenghua
committed
Oct 16, 2020
1 parent
5d45532
commit 52b745a
Showing
9 changed files
with
54 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
# (WIP) doc-the-lib 📝💨 | ||
# (WIP) vlib-docsify 📝💨 | ||
|
||
[![npm](https://img.shields.io/npm/v/doc-the-lib)](https://www.npmjs.com/package/doc-the-lib) | ||
[![npm](https://img.shields.io/npm/v/vlib-docsify)](https://www.npmjs.com/package/vlib-docsify) | ||
|
||
> A doc generator tool for libiary. based on vitepress. | ||
**Note this is early WIP! Currently the focus is on making doc-the-lib stable and feature complete first. It is not recommended to use this for anything serious yet.** | ||
**Note this is early WIP! Currently the focus is on making vlib-docsify stable and feature complete first. It is not recommended to use this for anything serious yet.** | ||
|
||
``` bash | ||
npm install -D doc-the-lib | ||
echo '# Hello doc-the-lib' > index.md | ||
npm install -D vlib-docsify | ||
echo '# Hello vlib-docsify' > index.md | ||
|
||
# starts dev server | ||
npx doc-the-lib | ||
npx vlib-docsify | ||
|
||
# build > .doc-the-lib/dist | ||
npx doc-the-lib build | ||
# build > .vlib-docsify/dist | ||
npx vlib-docsify build | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters