quicklysign/Wiki from folder
Create a wiki from 1 or more folders of MD files, & optionally generate a sidebar from the file structure of the src folders
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Apr 6, 2024
- License
- MIT
Pinned Snippet
uses: quicklysign/wiki-from-folder@dfcc1caed6ae533dfca6fd1fb7acff2068a55e2b # v1.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| folders | The directory or list of folders to generate the wiki from. Default is wiki. If you wish to include multiple directories, separate them with a comma (wiki, docs etc.). | — | wiki |
| sidebar | Whether or not you wish to generate a custom sidebar with categories based on the subdirectories of the input directory. Defaults to true. | — | true |
| prefix-files-with-dir | Whether or not to prefix file names with the directory they are in. This can be useful if you have multiple files with the same name in different directories, as github wikis completely ignore subdirectories and flatten everything out. Prefixed files will be named dir|filename.ext. Defaults to false. | — | false |
| branch-to-link-to | The branch to link to when wiki files link to code, images etc. Defaults to the default branch of the repository. | — | ${{ github.event.repository.default_branch }} |
| clear-wiki | Whether or not to clear the wiki before generating the new files. Defaults to false. This is useful if you do not want wiki pages from anywhere other than this action. | — | false |
| edit-warning | Whether or not to include a warning comment at the top of each generated file telling the viewer not to edit it and pointing them to the source file to edit instead. Defaults to true. | — | true |
| token | The token used to authenticate with the repository. Defaults to `github.token`. You only need to set this if you want to push to a wiki in a different repository, in which case this should be set to a PAT. | yes | ${{ github.token }} |
| host | The host to use for the wiki. Defaults to the server URL of the repository. Typically https://github.com. | yes | ${{ github.server_url }} |
| generated-files-dir | The directory in the wiki repository to store the generated files in. Defaults to generated. This is useful because it allows you to keep the generated files separate from any other files in the wiki, such as those created by users. | — | generated |
| sections-open-depth | The depth of the sidebar sections to be open by default. Defaults to 1. This means that all top level sections will be open, but any subsections will be closed. Setting this to 0 will close all sections by default. Setting this to -1 will open all sections by default. | — | 1 |
| make-src-dirs-sections | Whether or not to make the directories the wiki is being generated from into sections in the sidebar. Defaults to false. If this is true and sidebar is true, if the wiki is being created from a directory called wiki, the sidebar will have a section called wiki with all the files from that directory in it. If this is false and sidebar is true, the files in the root of wiki will be in the root of the sidebar. | — | false |
| repo | The repository to generate the wiki in. Defaults to the repository the action is running in. Only set this to a different repository if you want to generate a wiki in a different repository. If you do this, you will need to set the token input to a token with write access to the repository. | — | ${{ github.repository }} |
Outputs
no outputs