ahmadalli / public-notes

Documentation of my ideas, thoughts, and experiences.

Home Page:https://publicnotes.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Website

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

Installation

$ yarn

Local Development

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

$ yarn 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 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.

Style

This repo uses vale to enforce a consistent style across the documentation.

About

Documentation of my ideas, thoughts, and experiences.

https://publicnotes.io/

License:Creative Commons Attribution 4.0 International


Languages

Language:TypeScript 56.6%Language:Shell 22.2%Language:CSS 11.4%Language:JavaScript 9.8%