Freon Documentation

This project contains the sources for all documentation on Freon. It is powered by create-svelte.

Creating a documentation website

Create the website using (either npm or yarn will work) and browse through it.

# Install dependencies
yarn install

# create the content for navigation tree, check the internal links, and include the code fragments
yarn prepare

# create the website in the directory 'docs'
yarn build

# preview the website
yarn preview

Note: preview should not be used to serve your website in production.

Developing

During development, you can use the following commands.

# create the content for navigation tree, check the internal links, and include the code fragments
yarn prepare

# create the website and serve it on localhost:3000
yarn dev

# or start the server and open the app in a new browser tab
yarn dev -- --open

Publishing

In de docs folder:

• Check whether the .nojekyll file is there, to avoid GitHub from doing stuff that breaks the site.
• Check whether the CNAME file with www.freon4dsl.dev is there