MarkBind is a tool for generating static websites from markdown-like text, particularly suitable for text-heavy websites such as software project documentation.
Given below are some information useful for when you want to update documentation in a project that uses MarkBind.
npm install -g markbind-clito install the latest version of MarkBind.
MarkBind is a superset of Markdown. Refer the MarkBind user guide for more details.
First, start the live preview: Unless it is a trivial change, you would want to see how your change to the documentation source files will reflect in the generated website. You can use the MarkBind live preview mode to preview the generated website as you update the source file. To start the live preview mode,
[project root]/docs-- if you are not sure, look for the folder containing the
markbind servecommand. That will open the generated website in your default browser.
Next, edit the files you want:
While live preview can pick up most changes, it may not be able to pick up certain changes (e.g., changes to files in the
_markbind folder or changes to nunjucks macros). Furthermore, some syntax errors in your code can cause the live preview to crash. In those cases, just stop the server (Ctrl+C on Windows) and start it again.
Project admins can,