Giter Club home page Giter Club logo

Comments (3)

technote-space avatar technote-space commented on August 25, 2024

related technote-space/doctoc#14

from toc-generator.

technote-space avatar technote-space commented on August 25, 2024

@hanxiao
I added support for horizontal TOC.

e.g. https://github.com/technote-space/toc-generator/blob/master/__tests__/fixtures/doctoc/expected/README.horizontal.md

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)
スクリーンショット 2020-11-26 0 45 50

HTML_TEMPLATE: <p align="center"><sub>${ITEMS}</sub></p>
スクリーンショット 2020-11-26 0 46 22

SEPARATOR: '･'
スクリーンショット 2020-11-26 0 51 05

from toc-generator.

technote-space avatar technote-space commented on August 25, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.