Skip to content

Extends the continuous integration documentation capabilities of GitHub pages for everyone!

License

Notifications You must be signed in to change notification settings

bcardosolopes/rundocs.io

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

Extends the continuous integration documentation capabilities of GitHub pages for everyone!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%