Documentation PaxOS

Pour la consulter au format Markdown, allez dans le dossier docs du repo.

A l'attention des contributeurs

Le site web se met à jour automatiquement lorsqu'un commit est publié sur la branche main. Merci de faire des PR pour faire des modifications.

Installation

npm install
npm install rss-parser turndown axios

Local Development

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build
npm run serve

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.