This project was created a long time ago and is no longer maintained. Keeping it on github for archival but don't use this!
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!
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>
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>
- Minor improvements
- Fix jsDelivr issue
- Update favicon
- Publish to NPM
- Support for markdown
- Sidebars improved
- Redeisgned minimal theme now default
- All known bugs fixed
- UI for sidebars redesigned
- Massive overhaul to scrolling performance
- Bug fixes
- Bug fixes. DocsJS ready for public release!
- DocsJS.jumpTo() replaced with DocsJS.scroll()
- Bug fixes.
- DocsJS Released!
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.