Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ewilan-riviere/memorandum
Blog & documentation.
https://github.com/ewilan-riviere/memorandum
documentation markdown vite vitepress vue
Last synced: 2 months ago
JSON representation
Blog & documentation.
- Host: GitHub
- URL: https://github.com/ewilan-riviere/memorandum
- Owner: ewilan-riviere
- License: mit
- Created: 2020-03-14T14:45:57.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T16:46:39.000Z (5 months ago)
- Last Synced: 2024-09-18T16:40:48.079Z (5 months ago)
- Topics: documentation, markdown, vite, vitepress, vue
- Language: TypeScript
- Homepage: https://memorandum.ewilan-riviere.com
- Size: 7.11 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Memorandum
[![vitepress][vitepress-version-src]][vitepress-version-href]
[![node][node-src]][node-href]
[](https://github.com/antfu/eslint-config)
[](https://gitlab.com/kiwilan/memorandum)
Personal documentation, deploy on [memorandum.kiwilan.app](https://memorandum.kiwilan.app), built using [Vitepress](https://vitepress.dev/), a modern static website generator.
## Installation
```
pnpm i
```
```
pnpm dev
```
### Deployment
Check the [VitePress Deployment Guide](https://vitepress.dev/guide/deploy) for more details.
Build the project:
```sh
pnpm build
```
Preview the project:
```sh
pnpm preview
```
## Docker
You can use Docker to build and run the project.
Create a `.env` file:
```sh
cp .env.example .env
```
Build and run the project:
```sh
docker compose down
docker compose up --build -d
```
Website is available at `3000` port by default (you can change it in the `.env` file).
You can see the logs with:
```sh
docker logs memorandum -f # docker compose logs -f
```
You can find NGINX configuration for your server in [.vitepress/nginx/example.conf](.vitepress/nginx/example.conf).
## License
This project is licensed under the MIT License.
---
For a detailed explanation of how things work, check out [VitePress](https://vitepress.dev/).
[vitepress-version-src]: https://img.shields.io/badge/dynamic/json?label=VitePress&query=devDependencies[%27vitepress%27]&url=https://raw.githubusercontent.com/ewilan-riviere/memorandum/main/package.json&color=28CF8D&logo=vitepress&logoColor=ffffff&labelColor=18181b
[vitepress-version-href]: https://vitepress.dev/
[node-src]: https://img.shields.io/badge/dynamic/json?label=Node.js&query=engines[%27node%27]&url=https://raw.githubusercontent.com/ewilan-riviere/memorandum/main/package.json&color=28CF8D&labelColor=18181b
[node-href]: https://nodejs.org/en