{"id":21497314,"url":"https://github.com/paulo-amaral/easy-sop-docs","last_synced_at":"2026-05-14T20:06:04.187Z","repository":{"id":103173753,"uuid":"405813516","full_name":"paulo-amaral/easy-sop-docs","owner":"paulo-amaral","description":"Easy template to maintain  documentation websites. ","archived":false,"fork":false,"pushed_at":"2024-05-06T14:06:27.000Z","size":962,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-19T14:17:02.680Z","etag":null,"topics":["docs","documentation","docusaurus","ict","itil","itsm","javascript","open-source","opensource","react","sop"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/paulo-amaral.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-09-13T02:55:01.000Z","updated_at":"2025-06-02T05:11:53.000Z","dependencies_parsed_at":"2025-10-12T12:40:20.960Z","dependency_job_id":"8c169182-2731-4dd7-8932-f7f75862c9c2","html_url":"https://github.com/paulo-amaral/easy-sop-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/paulo-amaral/easy-sop-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulo-amaral%2Feasy-sop-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulo-amaral%2Feasy-sop-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulo-amaral%2Feasy-sop-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulo-amaral%2Feasy-sop-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paulo-amaral","download_url":"https://codeload.github.com/paulo-amaral/easy-sop-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paulo-amaral%2Feasy-sop-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33041251,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T13:14:54.681Z","status":"online","status_checked_at":"2026-05-14T02:00:06.663Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","docusaurus","ict","itil","itsm","javascript","open-source","opensource","react","sop"],"created_at":"2024-11-23T16:23:07.810Z","updated_at":"2026-05-14T20:06:04.156Z","avatar_url":"https://github.com/paulo-amaral.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HOWTO INSTALL \nPlease follow the steps bellow to install docusaurus for local development and build the static website.\n\n# Template\n\nThis template is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator, to provide a documentation system.\n\n# Prerequistes\n\n### Install NodeJS :\n- Windows : \nVisit - https://nodejs.org/en/download/current/ download the Windows Installer .msi (64-bit) file and install the package.\n\n- Linux(Debian):\n\n````console\nsudo apt-get install curl software-properties-common \ncurl -sL https://deb.nodesource.com/setup_16.x | sudo bash - \napt update\napt install nodejs npm\nnpm -v\nnvm -v\n````\n\n# Docusaurus \n\n##  1 - Clone repo and install\n\n```console\ngit clone https://github.com/paulo-amaral/easy-sop-docs.git\ncd easy-sop-docs\nnpm install\n```\n\n## 2 - Local Development\n\n```console\nnpm run start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without\nhaving to restart the server.\n\n\n## 3 - Build\n\n```console\nnpm run build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting\nservice.\n\n## 4 - Deployment with Docker and Docker compose\n\n- Install docker-ce and docker compose with this script : https://gist.github.com/paulo-amaral/d8995b42d6fc3b7a0984ee39ac927550 \n- Clone repo :\n\n  ```console\n  git clone https://github.com/paulo-amaral/easy-sop-docs.git\n  cd easy-sop-docs\n  docker-compose up -d --build\n  ````\n  \n\n## Install search\nDocussaurus doesn't have support to offline search(check docusaurus docs).\n\nThe search  is based on: \nhttps://github.com/lelouch77/docusaurus-lunr-search\n\n## Setup docusaurus for mermaid(diagrams)\n``\nnpm i mdx-mermaid mermaid\n``\n### Configure in Docusaurus\n\ndon't forget to change `docusaurus.config.js`\n\nAdd\n\n```js\nrequire('mdx-mermaid')\n```\n\nto `remarkPlugins`\n\ninto `docusaurus.config.js`\n\n```\npresets: [\n    [\n      '@docusaurus/preset-classic',\n      {\n        docs: {\n          remarkPlugins: [require('mdx-mermaid')],\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulo-amaral%2Feasy-sop-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaulo-amaral%2Feasy-sop-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulo-amaral%2Feasy-sop-docs/lists"}