1.2.7 • Published 7 years ago
docsjs v1.2.7
DocsJS 1.2.7
See how to use DocsJS at hailiax.io/docsjs/.
That site is also an example: it's a doc for DocsJS built with DocsJS containing live DocsJS examples. Doception!
Basic usage (HTML)
Add this to your <head>
.
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsjs@1/src/docs.min.js"></script>
<link href="https://cdn.jsdelivr.net/npm/docsjs@1/src/themes/Minimal.min.css" rel="stylesheet" id="DocsJS-theme">
Add this to your <body>
.
<docs-js sidebars="menu choice">
<s-c>
<h-d>
<t-l>Section header</t-l>
<t-x>Header content</t-x>
</h-d>
<t-p>
<t-l>Topic</t-l>
<t-x>Learn more at hailiax.io/docsjs/</t-x>
<e-g>Example</e-g>
<e-x>More</e-x>
</t-p>
</s-c>
</docs-js>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsjs@1/src/ace/ace.js"></script>
<script>DocsJS.init();</script>
Basic usage (Markdown)
Add this to your <head>
.
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsjs@1/src/docs.min.js"></script>
<link href="https://cdn.jsdelivr.net/npm/docsjs@1/src/themes/Minimal.min.css" rel="stylesheet" id="DocsJS-theme">
Add this to your <body>
.
<docs-js mode="markdown" sidebars="none menu"><!--
# Example markdown
DocsJS converts Markdown to custom tags and then handles the doc the same way it handles custom tag docs.
## Example topic
Bullet points
* Hello
* World
## Example code
Below you'll see some syntax-highlighted block code:
```javascript
var s = "JavaScript syntax highlighting";
alert(s);
```
Here is `some inline code`.
--></docs-js>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsjs@1/src/ace/ace.js"></script>
<script>DocsJS.init();</script>
Full changelog
1.2.7 // 3 Oct 2017
- Minor improvements
1.2.6 // 2 Oct 2017
- Fix jsDelivr issue
- Update favicon
1.2.3 // 2 Oct 2017
- Publish to NPM
1.2.0 // A mark up // 1 Oct 2017
- Support for markdown
- Sidebars improved
- Redeisgned minimal theme now default
- All known bugs fixed
1.1.0 // Sidebars // 26 Sep 2017
- UI for sidebars redesigned
- Massive overhaul to scrolling performance
- Bug fixes
1.0.3 // 24 Sep 2017
- Bug fixes. DocsJS ready for public release!
1.0.2 // 24 Sep 2017
- DocsJS.jumpTo() replaced with DocsJS.scroll()
1.0.1 // 23 Sep 2017
- Bug fixes.
1.0.0 // Initial // 17 Sep 2017
- DocsJS Released!
Note
docs.js is not commented out well and the code could use some cleaning. I'll probably clean up the code in the next update.
1.2.7
7 years ago
1.2.6
7 years ago
1.2.5
7 years ago
0.8.9
7 years ago
1.2.4
7 years ago
0.8.8
7 years ago
1.2.3
7 years ago
1.2.2
7 years ago
1.2.1
7 years ago
1.2.0
7 years ago
1.1.7
7 years ago
1.1.6
7 years ago
1.1.5
7 years ago
1.1.4
7 years ago
1.1.3
7 years ago
1.1.2
7 years ago
1.1.1
7 years ago
1.1.0
7 years ago
1.0.2
7 years ago
1.0.1
7 years ago
1.0.0
7 years ago
0.0.1
7 years ago
0.0.0
7 years ago