Skip to content

arbona-robin/doc-notes

Repository files navigation

Description

This is a simple static site generator. It generates a static site from markdown files. Using with a VPS, it can be used to host a simple blog / doc / notes. It use prismjs for code highlighting. Because it use github actions to deploy over shh/rsync, you can write your content in markdown and push to github on main branch, the site will be updated automatically. Directly edit the content in github web interface will also work.

Install dependencies

npm install

Create your own content

Content has to be written in markdown format and placed in the content directory. or other CONTENT_DIR defined in .env file.

It's mandatory to include the following frontmatter at the beginning of the file:

---
title: Some title
description: Some description
date: YYYY-MM-DD
tags: some, tags
---

They are used to generate the metadata of the page and to display the content in the home page.

Content support code highlighting, just use the following syntax:

```javascript
console.log('Hello, world!');
\```

Generate static site

npm run generate

Development

npm run dev

Deploy

Used pipeline to deploy to a VPS using rsync. Read the article here

git push origin main

About

Generate static site based on .md content of my notes / doc

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published