Code Monkey home page Code Monkey logo

rundocs.io's Introduction

RunDocs: Documentation Simplified

WARNING: SOME OPTIONS MAY NOT WORK, DOCS NEED UPDATE!

RunDocs extends the continuous integration documentation capabilities of GitHub pages for everyone!

The documents are stored in your own GitHub repository, GitHub pages will automatically build your docs so your code and documentation are always up-to-date.

Use markdown to write documents and leave the rest to us, and we provide you with free domain name!

Features

  • Automatically generate sidebar based on directory
  • Only need one file _config.yml to configure site
  • Search engine optimized
  • Document search (RegExp supported)
  • Support third-party comments
  • Google Analytics support

Quick start

The new repository will generate with the same files and folders from rundocs/starter-slim, You can preview the theme to see what it looks like, or even generate it today.

External resources

Here are some external resources to help you learn more about Jekyll.

rundocs.io's People

Contributors

segogithub avatar a6b8 avatar

Watchers

James Cloos avatar  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.