cblanken / kyoss-website

A Static Site Generator for KYOSS.org

KYOSS Static Site

A Static Site Generator for KYOSS.org/KYOSS.dev. This site uses VuePress to generate a static website from Markdown. Changes merged to the main branch will be automatically built and published via GitHub Actions.

How to add pages

1. Create a Markdown file in the docs/ subdirectory.
2. Add the Frontmatter to set the title/language/etc...

   ---
   lang: en-US
   title: Title of this page
   description: Description of this page
   ---
   

3. Add/Commit the new page to the git repository
4. Push your branch to your fork
5. Submit a pull request to merge your submission to the main branch

How to add static content (like images)

Full reference here

You can reference any assets using relative URLs in your Markdown content:

![An image](./image.png)

This is generally the suggested way to import images, as users usually place images near the Markdown file that references them.

How to run locally and preview changes

Required tools/technologies

1. NodeJS version 16 or higher
2. yarn, which can be installed via node package manager included with NodeJS
   • npm install --global yarn

Install the dependencies

In the root of this project run the following command

yarn

Run the web site in development mode (Changes trigger automatic reloading)

yarn docs:dev