GithubHelp home page GithubHelp logo

bojit / docs Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 428 KB

BOJIT documentation generator tools

License: MIT License

Dockerfile 1.85% HTML 12.70% JavaScript 35.54% Svelte 40.57% TypeScript 9.35%

docs's Introduction

docs

BOJIT documentation generator tools

Usage

With GitHub

TODO

Generic repository

TODO

Roadmap

Milestone 1

  • Svelte-Kit Docs building locally: change stylesheet
  • Integrate MDSVEX parsing
  • Add component styling from @bojit/svelte-components

Milestone 2

  • docs.bojit.config.js file:
    • Markdown sources root
    • use README.md as cover sheet
    • Doxygen/moxygen config options
  • build as action from another repository - NPM install in docker image.
  • FlexSearch

Milestone 3

  • Interactive editor: use FileReader API
  • Interactive editor: add widgets
  • Interactive editor: GitHub OAuth

Projects used

Development

cd docs
npm install
npm link ../app
npm run dev

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.