EasyDoc

EasyDoc is a simple but powerful technical documentation tool that generates completely local HTML pages and websites from markdown files. It offers rich markdown support and code highlighting features, using markdown-it and Prism respectively.

EasyDoc is fully configurable and customizable, allowing you to tailor global and per page settings, customize components, and edit its theme. It also provides built-in navigation features such as a table of contents on pages, individual site navigation, and a Tag Navigator module.

created by: Grandgeorg Websolutions

---

Requirements

• Node.js
• npm
• git (optional)

Install

Clone this repository:

# clone via https:
git clone https://github.com/grandgeorg/easydoc.git
# or clone via SSH (if you have a key):
git clone git@github.com:grandgeorg/easydoc.git

If you don't have git installed, you can also download the repository as a zip file and extract it.

Change into easydoc directory and run install:

cd ./easydoc/
npm install

You could now use EasyDoc from this directory, but we recommend, that for your documentations in different paths you use the setup.js from EasyDoc as follows:

# cd to some directory in some project of yours, 
# where you want to setup your documentation with EasyDoc
cd /some/project/docs
# run setup.js from easydoc with node
node /path/where/you/cloned/and/installed/easydoc/setup.js
# edit newly generated config files (.env, nav.js, package.json - author, description, keywords)
# put some md-files into docs directory
# you can now run
npm run build
# if you also want to use nodemon to watch your file changes first run
npm install
# then you can run
npm run watch

Usage

# watches on file changes and runs build:
npm run watch
# or build one time
npm run build

Manual & Reference & Demo

The manual and reference are generated with EasyDoc itself, so you can see how it looks like.

• Find more information in the EasyDoc manual.
• For configuration and further usage refer to the EasyDoc reference.