https://github.com/paulo-amaral/easy-sop-docs
Easy template to maintain documentation websites.
https://github.com/paulo-amaral/easy-sop-docs
docs documentation docusaurus ict itil itsm javascript open-source opensource react sop
Last synced: about 1 month ago
JSON representation
Easy template to maintain documentation websites.
- Host: GitHub
- URL: https://github.com/paulo-amaral/easy-sop-docs
- Owner: paulo-amaral
- License: mit
- Created: 2021-09-13T02:55:01.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T14:06:27.000Z (about 2 years ago)
- Last Synced: 2025-10-19T14:17:02.680Z (8 months ago)
- Topics: docs, documentation, docusaurus, ict, itil, itsm, javascript, open-source, opensource, react, sop
- Language: JavaScript
- Homepage:
- Size: 939 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HOWTO INSTALL
Please follow the steps bellow to install docusaurus for local development and build the static website.
# Template
This template is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator, to provide a documentation system.
# Prerequistes
### Install NodeJS :
- Windows :
Visit - https://nodejs.org/en/download/current/ download the Windows Installer .msi (64-bit) file and install the package.
- Linux(Debian):
````console
sudo apt-get install curl software-properties-common
curl -sL https://deb.nodesource.com/setup_16.x | sudo bash -
apt update
apt install nodejs npm
npm -v
nvm -v
````
# Docusaurus
## 1 - Clone repo and install
```console
git clone https://github.com/paulo-amaral/easy-sop-docs.git
cd easy-sop-docs
npm install
```
## 2 - Local Development
```console
npm run start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without
having to restart the server.
## 3 - Build
```console
npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting
service.
## 4 - Deployment with Docker and Docker compose
- Install docker-ce and docker compose with this script : https://gist.github.com/paulo-amaral/d8995b42d6fc3b7a0984ee39ac927550
- Clone repo :
```console
git clone https://github.com/paulo-amaral/easy-sop-docs.git
cd easy-sop-docs
docker-compose up -d --build
````
## Install search
Docussaurus doesn't have support to offline search(check docusaurus docs).
The search is based on:
https://github.com/lelouch77/docusaurus-lunr-search
## Setup docusaurus for mermaid(diagrams)
``
npm i mdx-mermaid mermaid
``
### Configure in Docusaurus
don't forget to change `docusaurus.config.js`
Add
```js
require('mdx-mermaid')
```
to `remarkPlugins`
into `docusaurus.config.js`
```
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
remarkPlugins: [require('mdx-mermaid')],
```