https://github.com/johanbook/docs

Docs on various subjects
https://github.com/johanbook/docs

docs markdown nodejs static-site wiki

Last synced: about 2 months ago
JSON representation

Docs on various subjects

• Host: GitHub
• URL: https://github.com/johanbook/docs
• Owner: johanbook
• Created: 2019-08-31T16:09:07.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-20T07:37:38.000Z (10 months ago)
• Last Synced: 2024-03-21T07:46:44.690Z (10 months ago)
• Topics: docs, markdown, nodejs, static-site, wiki
• Language: JavaScript
• Homepage:
• Size: 4.08 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Security: docs/security/_category_.json

Awesome Lists containing this project

README

        
# docs

![deploy](https://img.shields.io/github/actions/workflow/status/johanbook/docs/deploy.yaml)

![uptime](https://img.shields.io/uptimerobot/ratio/m793425276-368a1e113b433b3c04d08dd6)

![last commit](https://img.shields.io/github/last-commit/johanbook/docs)

**docs** is my coding wiki, hosted at

[johanbook.com/docs](https://johanbook.com/docs). They are written using

[markdown](https://www.markdownguide.org/) and compiled to a static site using

the Nodejs-based [Docusaurus](https://docusaurus.io/) framework.

## Found an error?

If something is incorrect or could be improved, open an issue in

[here](https://github.com/johanbook/docs/issues).

## Running locally

The documentation site can be run locally. It requires a Nodejs runtime and the

NPM package manager. The dependencies are installed by running

```sh

npm install -d

```

To start a development server run

```sh

npm run dev

```

## Deployment

The docs are hosted on Github pages and are built as part of a CD pipeline. The

compilation is done using Node v16 (LTS).