easy-sop-docs — Docusaurus Documentation Template

SHA-256: ff4a20c35a5e27b9bfaa31c980179f404bfaadd164c2a7349d6f74fab38e80fa

2026-10-01T03:46:01.161Z

# Easy SOP Docs

Simple Docusaurus 3 template for SOP documentation, runbooks, servers, IT policies, and operations.

## Requirements

- Node.js 18+
- npm

## Development

```bash
npm install
npm run start
```

## Build

```bash
npm run build
npm run serve
```

## Install Search

Docusaurus 3.10.1 provides first-class support for Algolia DocSearch, but local/offline search is still community-maintained. This project uses:

https://github.com/easyops-cn/docusaurus-search-local

The package is already installed and configured as a theme in `docusaurus.config.js`:

```js
themes: [
  '@docusaurus/theme-mermaid',
  [
    require.resolve('@easyops-cn/docusaurus-search-local'),
    {
      hashed: true,
      language: ['en', 'pt'],
      indexBlog: false,
      indexPages: true,
      docsRouteBasePath: '/',
    },
  ],
],
```

Search indexes are generated only from a production build:

```bash
npm run build
npm run serve
```

## Mermaid

Mermaid diagrams are already enabled:

````md
```mermaid
graph TD;
  A[Incident] --> B[Triage];
  B --> C[Resolution];
```
````

## Deployment with Docker and Docker Compose

Install `docker-ce` and Docker Compose with this script:

https://gist.github.com/paulo-amaral/d8995b42d6fc3b7a0984ee39ac927550

Clone the repository:

```bash
git clone https://github.com/paulo-amaral/easy-sop-docs.git
cd easy-sop-docs
docker-compose up -d --build
```

The site is available at http://localhost:3000.

With the newer Docker Compose plugin, this also works:

```bash
docker compose up -d --build
```

## GitHub Pages

The `.github/workflows/pages.yml` workflow publishes the `main` branch automatically.

Enable GitHub Pages with `GitHub Actions` as the source.

## Ansible

```bash
ansible-playbook -i deploy/ansible/inventory.example.ini deploy/ansible/deploy.yml
```

Edit the host in `deploy/ansible/inventory.example.ini` before running it.