Code Monkey home page Code Monkey logo

imgui-docs's Introduction

Dear ImGui Documentation Site

This is an attempt at creating higher level documentation for the wonderful Dear ImGui library. Demo here.

I've also started working on a getting started guide, however it is still very much a WIP.

The documentation is all written in markdown. I am using a tool called docsify which is a lightweight documentation generator, and runs entirely on the client side. (There is no 'build docs' step)

It can be hosted with any static hosting tool pointing to the root directory. For example, there is a live demo hosted with github pages.

Locally one can use any http(s) static server tools for development. See a list oneliners using common tools here

For example, if you have python 3 installed:

git clone https://github.com/PossiblyAShrub/imgui-docs
cd imgui-docs
python -m http.server 3000

And then visit http://localhost:3000.

Because the docs are just markdown files, it can be viewed in any markdown viewer.

Also! If you visit the documentation (via the site, or a local http server) using any modern web browser (service workers must be enabled) you can view the docs offline! Try visiting the site after disabling you connection/stopping your local server

imgui-docs's People

Contributors

possiblyashrub 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.