Skip to content

Building a website that I will document all handwritten notes in Markdown and have handy at all times.

License

Notifications You must be signed in to change notification settings

stevenovak123/learndocs

Repository files navigation

Learn docs is built with the intention to have notes and cheatsheets with easy access. These are all my personal learnings/ notes made by me for the topics. These are not a general notes for a topic.

Tech Stack

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

Quickstart

You are free to contribute to the project.

  1. Local Development

Brief documentation is below.

Local development

This environment is fully on computer and requires each dependency to be installed and set up, but gives you the most flexibility for customisation.

Prerequisites

Before contributing or adding a new feature, please make sure you have already installed the following tools:

  • NodeJs (Works with Node LTS version)
  • yarn - a package manager built by Facebook

Commands

You can set this up locally with the following steps:

  1. yarn install
  2. yarn start

this will start the project on your local development server. Then make your changes and raise PR to the project.

Deployment

cmd /C "set "GIT_USER=<GITHUB_USERNAME>" USE_SSH=true && yarn deploy"

About

Building a website that I will document all handwritten notes in Markdown and have handy at all times.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published