Comments (3)
related technote-space/doctoc#14
from toc-generator.
@hanxiao
I added support for horizontal TOC.
To use it, set the HTML_MODE
option to true
.
https://github.com/technote-space/toc-generator#options
- name: Generate TOC
uses: technote-space/toc-generator@v3
with:
GITHUB_TOKEN: ${{ secrets.JINA_DEV_BOT }}
COMMIT_NAME: Jina Dev Bot
COMMIT_EMAIL: [email protected]
TOC_TITLE: ''
TARGET_PATHS: 'README.md'
CHECK_ONLY_DEFAULT_BRANCH: true ## If you want not to check existing PRs
HTML_MODE: true
# HTML_TEMPLATE: <p align="center"><sub>${ITEMS}</sub></p> ## change template
# SEPARATOR: '・' ## change separator
- name: Generate TOC
uses: technote-space/toc-generator@v3
with:
MAX_HEADER_LEVEL: 2
GITHUB_TOKEN: ${{ secrets.JINA_DEV_BOT }}
COMMIT_NAME: Jina Dev Bot
COMMIT_EMAIL: [email protected]
TOC_TITLE: ''
TARGET_PATHS: 'CHANGELOG.md,CONTRIBUTING.md' ## not horizontal TOC
CHECK_ONLY_DEFAULT_BRANCH: true ## If you want not to check existing PRs
e.g.
HTML_TEMPLATE: <p align="center">${ITEMS}</p>
(default)
HTML_TEMPLATE: <p align="center"><sub>${ITEMS}</sub></p>
from toc-generator.
To generate with different options, you need to use this actions separately.
That's probably okay, but it may result in a `non-fast-forward' error.
from toc-generator.
Related Issues (20)
- Broken link found (https://docs.github.com/en/github/site-policy/github-privacy-statement)
- Broken link found (https://docs.github.com)
- Broken link found (https://docs.github.com)
- Broken link found (https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#pull-request-event-pull_request)
- Broken link found (https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
- Broken link found (https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)
- Broken link found (https://developer.github.com/v3/activity/events/types/#webhook-payload-example-28)
- Broken link found (https://docs.github.com/en/github/site-policy/github-terms-of-service)
- Broken link found (https://docs.github.com/en/github/site-policy/github-privacy-statement)
- Broken link found (https://docs.github.com)
- Support signoff commit HOT 1
- Broken link found (https://docs.github.com/articles/which-remote-url-should-i-use)
- Broken link found (https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
- Broken link found (https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)
- Broken link found (https://docs.github.com/en/github/site-policy/github-terms-of-service)
- Broken link found (https://docs.github.com/en/github/site-policy/github-privacy-statement)
- <!-- DOCTOC SKIP --> doesn't work HOT 2
- Translate README into Chinese HOT 1
- CREATE_PR doesnt seem to be working with `on:push` HOT 1
- Permission denied to github-actions[bot] HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from toc-generator.