change all the things

Transition to docusarus for documentation site

Author: glimberg

.github/workflows/auto-commit.yml

@@ -24,3 +24,6 @@ Icon
 Network Trash Folder
 Temporary Items
 .apdisk
+
+node_modules/
+

.gitignore

@@ -1,5 +1,5 @@
+
 all:
+	npm install
 	./build.sh all
-
-clean:
-	./build.sh clean
+	npm run build

Makefile

@@ -1,51 +1,33 @@
-![Try our extra BIG-ASS Manual. Now with more... MARKDOWN](./artwork/hero.png)
+# Website
 
-> It doesn’t matter how good your product is, because if its documentation is not good enough, people will not use it
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
 
-## Examples
+## Installation
 
-  - [Manual](http://10.6.6.250:8000/guides/manual/manual.html)
-  - [SDK C/C++ Reference](http://10.6.6.250:8000/reference/libzt-c/html/ZeroTierSockets_8h.html)
-  - [SDK Guide](http://10.6.6.250:8000/guides/libzt/#getting-started)
-
-## What are we doing?
-
-We are auto-generating all [four categories](https://diataxis.fr/introduction/) of documentation from markdown and source files.
-
-- Tutorials
-- How-to guides
-- Explanation
-- Reference
-
-## Usage
-
- 1. Edit your source material in `src/`
- 2. Commit your changes -- Github actions will take care of the rest
- 3. You're done. Now go do something else
+```console
+yarn install
+```
 
-## How it works
+## Local Development
 
-On each push, [.github/workflows/auto-commit.yml](.github/workflows/auto-commit.yml) triggers a rebuild of all documentation in the [src](./src) directory and outputs it to [dst](./dst). Language-specific tools are used to generate API reference documentation (stuff like Doxygen, javadoc, whatever). This covers the `Reference` category. Then, [slatedocs/slate](https://github.com/slatedocs/slate) is used to generate pretty tutorial-like guides. This covers the remaining three categories `Tutorials`, `How-to guides` and `Explanation`. The result is a set of trivially-hostable static html and javascript that we can dump in a small bucket somewhere. You can manually invoke a build of everything using `make` if you have docker and all of the required tools for your use-case.
+```console
+yarn start
+```
 
-Styling assets for the various tools are stored in `style/` and copied during and/or after builds.
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
-## Add Your Project
+## Build
 
- - Add build steps in [build.sh](./build.sh)
- - The `Makefile` just calls `build.sh`. I just like typing make, it rolls off the keyboard faster but I hate using make for anything complex.
+```console
+yarn build
+```
 
-## Pro-tip
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-Add this to your shell profile:
+## Deployment
 
+```console
+GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
 ```
-docs()
-{
-	MSG=${1:-"Documentation edit"}
-	echo $MSG
-	git pull
-	git add .
-	git commit -m $MSG -S
-	git push
-}
-```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

README.md

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

artwork/documentashun.png

@@ -1,27 +1,11 @@
 #!/bin/bash
 
-################################################################################
-# STYLE FIXES                                                                  #
-################################################################################
-
-apply-slate-style-to()
-{
-	mkdir -p $1
-	cp -rf style/slate/* $1
-}
-
-remove-slate-style-from()
-{
-	cd $1
-	rm -rf fonts images includes javascripts layouts stylesheets
-	cd -
-}
+if [[ "$OSTYPE" == "darwin"* ]]; then
+	DOXYBOOK="bin/doxybook-mac"
+elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
+	DOXYBOOK="bin/doxybook-linux"
+fi
 
-apply-doxygen-style-to()
-{
-	mkdir -p $1
-	cp -f style/doxygen/*.png $1
-}
 
 ################################################################################
 # PROJECTS                                                                     #
@@ -38,30 +22,33 @@ manual()
 libztcore()
 {
 	# API REFERENCE
-	mkdir -p dst/reference/libztcore-c # dst
-	cd src/reference/libztcore-c # src
-	git clone https://github.com/zerotier/zerotierone.git repo
+	pushd reference/libztcore-c # src
 	doxygen
 	rm -rf repo
-	cd -
-	apply-doxygen-style-to dst/reference/libztcore-c/html
+	popd
+
+	rm -rf docs/autogen/libztcore
+	mkdir -p docs/autogen/libztcore
+	$DOXYBOOK -i reference/libztcore-c/tmp/xml -o docs/autogen/libztcore/ --config doxybook2/config/doxybook-config-zerotier.json --templates doxybook2/template/libzt
+	rm -f docs/autogen/libztcore/files/dir_*.md
+	echo '{"label": "API Reference", "position": 9}' > docs/autogen/libztcore/_category_.json
+	rm -rf reference/libztcore-c/tmp
 }
 
 libzt()
 {
 	# API REFERENCE
-	mkdir -p dst/reference/libzt-c # dst
-	cd src/reference/libzt-c # src
-	#git clone https://github.com/zerotier/libzt.git repo
+	mkdir -p docs/autogen/libzt-c # dst
+	pushd reference/libzt-c # src
 	doxygen
-	#rm -rf repo
-	cd -
-	apply-doxygen-style-to dst/reference/libzt-c/html
+	popd
 
-	# GUIDE
-	apply-slate-style-to src/guides/libzt/
-	docker run --rm --name slate -v $(pwd)/dst/guides/libzt:/srv/slate/build -v $(pwd)/src/guides/libzt:/srv/slate/source slatedocs/slate
-	remove-slate-style-from src/guides/libzt/
+	rm -rf docs/autogen/libzt/* 
+	mkdir -p docs/autogen/libzt
+	$DOXYBOOK -i reference/libzt-c/tmp/xml -o docs/autogen/libzt --config doxybook2/config/doxybook-config-libzt.json --templates doxybook2/template/libzt
+	rm -f autogen/libzt/files/dir_*.md
+	echo '{"label": "API Reference", "position": 9}' > docs/autogen/libzt/_category_.json
+	rm -rf reference/libzt-c/tmp
 }
 
 ################################################################################
@@ -85,14 +72,14 @@ are-there-changes-we-care-about()
 
 clean()
 {
-	rm -rf dst
+	rm -rf docs/autogen/*
 }
 
 all()
 {
 	#are-there-changes-we-care-about
 
-	manual
+	#manual
 	libztcore
 	libzt
 	#terraport

artwork/documentashun_s.png

@@ -0,0 +1,30 @@
+<!doctype html>
+<html lang="en" dir="ltr">
+<head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width,initial-scale=1">
+<meta name="generator" content="Docusaurus v2.0.0-alpha.73">
+<link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="ZeroTier Documentation Blog RSS Feed">
+<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="ZeroTier Documentation Blog Atom Feed"><title data-react-helmet="true">Page Not Found | ZeroTier Documentation</title><meta data-react-helmet="true" property="og:title" content="Page Not Found | ZeroTier Documentation"><meta data-react-helmet="true" property="og:url" content="https://docs.zerotier.com/404.html"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_tag" content="default"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://docs.zerotier.com/404.html"><link data-react-helmet="true" rel="alternate" href="https://docs.zerotier.com/404.html" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://docs.zerotier.com/404.html" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.ac863d77.css">
+<link rel="preload" href="/assets/js/styles.677a4bb9.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.4cd1716d.js" as="script">
+<link rel="preload" href="/assets/js/main.777a9448.js" as="script">
+<link rel="preload" href="/assets/js/1.accfc5a0.js" as="script">
+<link rel="preload" href="/assets/js/2.4213ea57.js" as="script">
+<link rel="preload" href="/assets/js/82.828490fa.js" as="script">
+<link rel="preload" href="/assets/js/84.6387da1f.js" as="script">
+<link rel="preload" href="/assets/js/935f2afb.7ac3aafe.js" as="script">
+</head>
+<body>
+<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
+<div><a href="#main" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><a class="navbar__brand" href="/"><img src="/img/ZeroTierIcon.png" alt="My Site Logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/ZeroTierIcon.png" alt="My Site Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><strong class="navbar__title">ZeroTier Documentation</strong></a></div><div class="navbar__items navbar__items--right"><div class="react-toggle displayOnlyInLargeViewport_GrZ2 react-toggle--disabled" role="button" tabindex="-1"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_71bT">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/img/ZeroTierIcon.png" alt="My Site Logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/ZeroTierIcon.png" alt="My Site Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><strong class="navbar__title">ZeroTier Documentation</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"></ul></div></div></div></nav><div class="main-wrapper"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/zerotier/ztintro">ZeroTier</a></li><li class="footer__item"><a class="footer__link-item" href="/libzt/manual.html">libzt SDK</a></li><li class="footer__item"><a class="footer__link-item" href="/centralv1">Central API</a></li><li class="footer__item"><a class="footer__link-item" href="/servicev1">Service API</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a href="https://discuss.zerotier.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">ZeroTier Discussions</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a href="https://github.com/zerotier/ZeroTierOne" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2021 ZeroTier, Inc. Built with Docusaurus.</div></div></div></footer></div>
+<script src="/assets/js/styles.677a4bb9.js"></script>
+<script src="/assets/js/runtime~main.4cd1716d.js"></script>
+<script src="/assets/js/main.777a9448.js"></script>
+<script src="/assets/js/1.accfc5a0.js"></script>
+<script src="/assets/js/2.4213ea57.js"></script>
+<script src="/assets/js/82.828490fa.js"></script>
+<script src="/assets/js/84.6387da1f.js"></script>
+<script src="/assets/js/935f2afb.7ac3aafe.js"></script>
+</body>
+</html>