Unverified Commit 249eeb7b authored by hucscsys's avatar hucscsys Committed by GitHub

Initial commit

parents
remote_theme: false
debug:
compress: false
dist: true
shortcodes: true
theme: jekyll-rtd-theme
# Receive the release note by dependabot
version: 2
updates:
- package-ecosystem: "bundler"
directory: "/"
schedule:
interval: "daily"
target-branch: "master"
versioning-strategy: "increase"
.jekyll-metadata
_site
.sass-cache
Gemfile.lock
source "https://rubygems.org"
gem "jekyll-rtd-theme", "~> 2.0.5"
gem "github-pages", group: :jekyll_plugins
DEBUG=JEKYLL_GITHUB_TOKEN=blank PAGES_API_URL=http://0.0.0.0
default:
@gem install jekyll bundler && bundle install
update:
@bundle update
clean:
@bundle exec jekyll clean
build: clean
@${DEBUG} bundle exec jekyll build --profile --config _config.yml,.debug.yml
server: clean
@${DEBUG} bundle exec jekyll server --livereload --config _config.yml,.debug.yml
# 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
<!-- prettier-ignore-start -->
| source | link |
| --------------- | -------------------------------------------------------------- |
{% for page in site.pages -%}
| {{ page.path }} | [{{ page.url | relative_url }}]({{ page.url | relative_url }}) |
{% endfor %}
<!-- prettier-ignore-end -->
## 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
title: Your awesome title
lang: en
description: Write an awesome description for your new site here
remote_theme: rundocs/jekyll-rtd-theme
readme_index:
with_frontmatter: true
exclude:
- Makefile
- Gemfile
- Gemfile.lock
plugins:
- jemoji
- jekyll-avatar
- jekyll-mentions
---
sort: 1
---
# Docs folder
{% include list.liquid all=true %}
# I'm folder1
source: `{{ page.path }}`
# file1
source: `{{ page.path }}`
# file2
source: `{{ page.path }}`
# file3
source: `{{ page.path }}`
# I'm folder2
source: `{{ page.path }}`
# file1
source: `{{ page.path }}`
# file2
source: `{{ page.path }}`
# file3
source: `{{ page.path }}`
# I'm folder1
source: `{{ page.path }}`
# file1
source: `{{ page.path }}`
# file2
source: `{{ page.path }}`
# file3
source: `{{ page.path }}`
# I'm folder2
source: `{{ page.path }}`
# file1
source: `{{ page.path }}`
# file2
source: `{{ page.path }}`
# file3
source: `{{ page.path }}`
# I'm folder1
source: `{{ page.path }}`
# file1
source: `{{ page.path }}`
# file2
source: `{{ page.path }}`
# file3
source: `{{ page.path }}`
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment