sator-imaging/docfx for GitHub Pages
Deploy beautiful API reference to GitHub Pages with only 1 action. No unnecessary file upload and complicated `docfx` setup.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| app_name | Text shown next to header logo. Default 'docfx-pages' | yes | docfx-pages |
| site_title | Website title used as suffix for HTML pages. ex) "HTML Page Title | <site title>" Default 'docfx for GitHub Pages' | yes | docfx for GitHub Pages |
| site_footer | Footer text for generated pages. HTML accepted. Default '© 2023 Sator Imaging' | yes | © 2023 Sator Imaging |
| docfx-version | Default '2.78.3' | — | 2.78.3 |
| define_symbols | Define additional preprocessor symbols. (separate symbols by ';') Default '' | — | "" |
| class_members | Generate all-in-one class api document or separate each member into pages. Accepts one of: 'separatePages' | 'samePage' Default 'separatePages' | — | separatePages |
| site_logo | Website logo file path. Accepts full-qualified URI or relative path to '.docfx' folder. Default 'images/wikimedia-commons/logo-csharp-recolor.svg' | — | images/wikimedia-commons/logo-csharp-recolor.svg |
| site_favicon | Favicon file path. Accepts full-qualified URI or relative path to '.docfx' folder. Default 'images/wikimedia-commons/logo-csharp-recolor.svg' | — | images/wikimedia-commons/logo-csharp-recolor.svg |
| google_analytics | Google Analytics ID. Leave empty to disable this feature. Default '' | — | "" |
| main_js | Default '' | — | "" |
| main_css | Default '' | — | "" |
Outputs
| name | description |
|---|---|
| page_url | URL to deployed GitHub Pages |