Giter Club home page Giter Club logo

codemonkeys-docs's Introduction

๐Ÿ’ CodeMonkeys Docs

This is the repository is for the nice, friendly docs that will teach you to use the CodeMonkeys framework. If that's not what you're looking for, try these:

๐Ÿ›  Contributing

A GitHub Action to builds and deploys the docs, and the main content is entirely written in markdown, so contributing is easy (for me too)!

If you want to contribute, please fork the repo and create a PR.

Repo Details:

  • Vue CLI app
  • Vue Router exposes main pages via the primary nav
  • Page content written in markdown
    • please follow established patterns for [toc], codeblocks, etc
    • rendered using markdown-it and plugins such as prismjs
    • highly customized using Tailwind and SCSS
  • eslint is enforced

Please make PRs that only change either markdown content or the Vue app/styles, not both.

๐Ÿ“ Note About Sphinx

The Sphinx docs are auto-generated from source code documentation when new versions of CodeMonkeys (the package itself) are published to main. If you want to contribute to those, you'll have to create a PR to the main CodeMonkeys repo.

codemonkeys-docs's People

Contributors

cooleydw494 avatar

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.