https://github.com/githubtraining/docsify-action
repo for docsify action
https://github.com/githubtraining/docsify-action
Last synced: 8 months ago
JSON representation
repo for docsify action
- Host: GitHub
- URL: https://github.com/githubtraining/docsify-action
- Owner: githubtraining
- Created: 2020-10-14T05:30:04.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-11-16T19:35:46.000Z (about 5 years ago)
- Last Synced: 2023-05-22T10:55:15.713Z (over 2 years ago)
- Language: JavaScript
- Size: 229 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docsify-action
## Overview
This action manages content creation in a standardized way. We serve a lot of things to GitHub Pages using Docsify and having a standard template for this process will increase the velocity at which we can create and release new stuff 😄
## Usage Examples
Using this action is simple. You need two things to get started
1. docsifyConfig.yml
This file configures the title, template and filenames for your project
**example:**
```
documentTitle: GitHub Foundations
templateVersion: lesson-plan
pageTitles:
- create github actions
- Some other document I want to include
```
**Template Reference Table**
_This table will be update as more templates and use cases are created_
| templateVersion | purpose | Release Tag Availability|
| --------------- | --------------------------------- |---|
| lesson-plan | Github certification lesson plans | v1.0|
| blank| Blank markdown files for free-form content that get automatically added to the Docsify sidebar|v1.1|
2. docsify-repo.yml workflow file
**example:**
```
name: lesson planner
on:
push:
branches-ignore:
- main
paths:
- docsifyConfig.yml
jobs:
run-lesson-planner:
runs-on: ubuntu-latest
steps:
- name: checkout the repo
uses: actions/checkout@v2
- name: use lesson planner
uses: githubtraining/docsify-action@v1.0
with:
github-token: ${{secrets.GITHUB_TOKEN}}
```