https://rundocs.github.io/starter/

Quick start document with gem template
https://rundocs.github.io/starter/

theme

Last synced: about 2 months ago
JSON representation

Quick start document with gem template

• Host: GitHub
• URL: https://rundocs.github.io/starter/
• Owner: rundocs
• Created: 2020-07-23T08:29:20.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-21T12:11:36.000Z (over 3 years ago)
• Last Synced: 2024-07-27T09:34:02.793Z (about 2 months ago)
• Topics: theme
• Language: Makefile
• Homepage: https://rundocs.github.io/starter
• Size: 5.86 KB
• Stars: 5
• Watchers: 2
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-learning - RunDocs - Documentation your projects. [Here](https://zhuanlan.zhihu.com/p/323457078) is a tutorial of how to create an website page document for your projects using [Gihub Page](https://pages.github.com/) and [RunDocs](https://github.com/rundocs/rundocs.io/tree/master/docs) (Websites)

README

        
# starter

1. [Generate with the same files and folders](https://github.com/rundocs/starter/generate) from this repository

2. Set up your GitHub Pages to source(`/`)

3. Now you can view your documentation in your site

## site.pages

| source          | link                                                           |

| --------------- | -------------------------------------------------------------- |

{% for page in site.pages -%}

| {{ page.path }} | [{{ page.url | relative_url }}]({{ page.url | relative_url }}) |

{% endfor %}

## Documents

https://jekyll-rtd-theme.rundocs.io

## Local debug

```sh

make

make server

```

## The license

The theme is available as open source under the terms of the MIT License