nevinkoshydaniel/docusaurus_trial

Website

This project is aiming to create a Portfolio page, to understand the basics of Docusaurus Engine, focusing on standard practise and techniques used in Documentation as Code philosophy, ensuring the technical capabilities of the documentation engine are utilized.

The project is hosted using Github Pages, with an eventual integration of Github Action CI-CD pipeline for deployments. It is a start of a learning journey, and I hope I can make it big.

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ pnpm install

Local Development

$ pnpm 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

$ pnpm build

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 pnpm 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.