Skip to content

Commit f41b56f

Browse files
committed
version 0.1.0
0 parents  commit f41b56f

19 files changed

+9613
-0
lines changed

.eslintignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
**/.cache/
2+
**/dist/
3+
**/node_modules/

.eslintrc.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"env": {
3+
"browser": true,
4+
"es2021": true
5+
},
6+
"extends": [
7+
"google",
8+
"eslint:recommended"
9+
],
10+
"parserOptions": {
11+
"ecmaVersion": 12,
12+
"sourceType": "module"
13+
},
14+
"rules": {},
15+
"globals": {
16+
"Docsify": "readonly",
17+
"$docsify": "readonly",
18+
"pseudocode": "readonly"
19+
}
20+
}

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
**/.cache/
2+
**/node_modules/

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Hunter Hwang
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

dist/docsify-pseudocode.js

Lines changed: 171 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/docsify-pseudocode.js.map

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/docsify-pseudocode.min.js

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/.nojekyll

Whitespace-only changes.

docs/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Docsify Pseudocode
2+
3+
## What it is
4+
5+
**docsify-pseudocode** is a plugin based on [pseudocode.js](https://github.com/SaswatPadhi/pseudocode.js) to render pseudocode in docsify. Using it, you can easily write pseudocode like Latex's algorithm packages in the markdown document.
6+
7+
## Features
8+
9+
All features come from pseudocode.js.
10+
11+
- **Intuitive grammar:** docsify-pseudocode takes a LaTeX-style input that supports the algorithmic constructs from LaTeX's algorithm packages. With or without LaTeX experience, a user should find the grammar fairly intuitive.
12+
- **Print quality:** The HTML output produced by docsify-pseudocode is (almost) identical with the pretty algorithms printed on publications that are typeset by LaTeX.
13+
- **Math formula support:** Inserting math formulas in docsify-pseudocode is as easy as LaTeX. Just enclose math expression in `$...$` or `\(...\)`.
14+
- **Multiple backends:** docsify-pseudocode supports [KaTex](https://github.com/KaTeX/KaTeX) and [MathJax](https://github.com/mathjax/MathJax) to render math formulas.
15+
16+
## Support
17+
18+
- Create a [GitHub issue](https://github.com/h-hg/docsify-pseudocode/issues) for bug reports, feature requests, or questions
19+
- Add a ⭐️ [star on GitHub](https://github.com/h-hg/docsify-pseudocode) to support the plugin!
20+
21+
## License
22+
23+
This project is licensed under the terms of the [MIT](https://github.com/h-hg/docsify-pseudocode/blob/master/LICENSE) license.

docs/_sidebar.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- [Installation](installation.md)
2+
- [Usage](usage.md)
3+
- [Change Logs](changelogs.md)

0 commit comments

Comments
 (0)