We can only keep contributing on open source basis, with your support. Help us with donations, so our team can spend full-time to the ecosystem.
Donation pool for the Zignar Technologies Team (IOTA)
iota1qp4d7j0s8t0p8tuy2acsu7y3xk3asz07w23pw7gu5cds2q6udqav5k5lzk2
Welcome to Zignar Technologies Documentation application. In this application documents can be created, edited and published.
The documents in this application are written in simple Markdown language, as it is widely used in many websites around the world. Markdown is easy to use and easy to master. Markdown files with extension .md can be stored in any place inside the /docs folder or in subdirectories of that folder (i.e. /docs/projects), and the documentation system will automatically parse the new document and create the required links in the menu structure.
.
└─ docs/
├─ index.md
├─projects/
├─ your_page.md
├─ some_other_page.md
└─ some_other_directory/
Documents and Directories can be directly edited in the wiki GitHub repository by pressing the :material-pencil: icon at the top right corner of the page. Also, documents can be edited locally by cloning the git repository. To achieve this the following command can be used:
git clone https://github.com/Zignar-Technologies/wiki.git
Once the repository has been cloned or pulled, folders and markdown files can be added to the /docs directory structure, and later committed back on GitHub.
Because the documentation system is based on Markdown files, any editor like VSCode or Atom can be used to preview your document as you write. However, the extended syntax that is used which provides better code blocks, content tabs, etc., will not be displayed fully.
To achieve this, a live preview server that can also be accessed locally with a Web Browser, so that changes can be previewed as the documentation is written. The server will automatically rebuild the site upon saving your document. This server can be run directly by building a Docker image and running it.
To run the local preview server with docker:
cd wiki
docker build -t zignardocs .
After the image is built, the server can be started it with the following command:
docker run -itd -p 8000:8000 --name ZignarDocs -v ${PWD}:/docs zignardocs
docker run -itd -p 8000:8000 --name ZignarDocs -v %cd%:/docs zignardocs
Now, the live server can be accessed from a local browser at address localhost:8000
The great thing about hosting project documentation in a git repository is
the ability to deploy it automatically when new changes are committed. As the code is already on GitHub Pages, it's certainly the most convenient way to publish the project documentation and it's free of charge.
A GitHub workflow runs every time that the files in the repository are created or changed, automatically publishing the changes to the docs.zignar.io website. This automates the deployment of the project documentation. When a new commit is pushed to the main branch, the static site is automatically built and deployed.