https://github.com/arcanis/mael.dev-docs

https://github.com/arcanis/mael.dev-docs

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/arcanis/mael.dev-docs
• Owner: arcanis
• Created: 2021-12-22T18:29:53.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T17:03:43.000Z (9 months ago)
• Last Synced: 2024-05-01T21:19:40.168Z (8 months ago)
• Language: TypeScript
• Size: 3.44 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Documentation Boilerplate

The following repository contains a generic [Docusaurus](https://docusaurus.io/) setup used across all my project websites. This avoids me having to keep them all in sync, which would be an impossible task.

## Development

To work on the website, clone this repository, clone another of my projects (for example [Clipanion](https://github.com/arcanis/clipanion)), run an install in both, then run the following command:

```

DOC_PROJECT_CWD=~/path/to/clipanion yarn start

```

## Deployment

> You probably shouldn't use my boilerplate for your projects, as I make no guarantee that I won't make breaking changes.

I use Netlify to deploy my open-source websites, with the following configuration on each one:

**Base directory**

```

website

```

**Build command**

```

curl https://raw.githubusercontent.com/arcanis/mael.dev-docs/main/install.sh | tee /dev/stderr | bash

```

**Publish directory**

```

website/build

```