Code Monkey home page Code Monkey logo

learndocs's Introduction

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"

learndocs's People

Contributors

stevenovak123 avatar

Stargazers

Roman avatar

Watchers

 avatar

learndocs's Issues

Github action to deploy to githubpages

Need an action that will deploy to the github pages on every push to the master branch.
The branch being used for the deployment to github pages is main.

Update Readme.md

Update readme for the project and add all necessary details.

  1. What is the project
  2. Tech Stack
  3. Content of the project
  4. How to setup locally

Update meta tags

Research on Docusaurus and how to update meta tags for the webpage.

Color scheme & Font

Pick up a new color scheme for both dark and light mode of the website. Also find a good font to set along with fallbacks

New Assets / Logos for the webpage.

Currently the basic docusaurus assets are being used as the favicon and the meta tag image. Need to change those/ find a generator for the same and get some logo going on.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.