Initial setup #1
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ith repository usage
…ild, deleting docker compose as this is too convoluted to run in docker without oa lot of work
… plugins. Commented out awesome-plugins as it was interfering with nav section
* Move docs to github folder * Update requirements.txt to include glightbox * Add docker compose for local dev * Update readme to use docker compose * Move to actions folder * Enable action to use local defaults * Update readme to use action as recommendation * Add override option
minottic
reviewed
Sep 24, 2025
README.md
Outdated
| │ └── workflows/publish-docs.yml | ||
| ├── docs/> └──Example.md | ||
| ``` | ||
| Once you have added your documentation you need to add it to the navigation on the `.github/actions/mkdocs/mkdocs.yml`. Open the file and add your page in the nav section: |
|
|
||
| extra_css: | ||
| - css/custom.css | ||
| hooks: |
There was a problem hiding this comment.
for this first implementation, I would remove the hook, it is a bit scicatlive specific
There was a problem hiding this comment.
we probably need an explanation of the action here, including inputs
LAShemilt
force-pushed
the
initial-setup
branch
from
8fb0683 to
0012901
Compare
…y mkdocs. Included instructions in the repo's README.md
minottic
reviewed
Sep 26, 2025
README.md
Outdated
|
|
||
| ### Use a docs directory | ||
|
|
||
| Make a `docs` directory in the root directory of your repository and add markdown files to it. To use add your new files to the docs you will need to copy the file [./.github/actions/mkdocs-pages/mkdocs.yml](./.github/actions/mkdocs-pages/mkdocs.yml) to your repository in a `.github/actions/mkdocs` directory. From here add to the `nav` panel to add your new docs. |
There was a problem hiding this comment.
I think this section is wrong, if I understand right there is no need to copy the file, but only do what explained in the example
README.md
Outdated
| site_name: my-site-name | ||
| ``` | ||
|
|
||
| If your pages setup requires additional Python packages, you can specify them in [.github/mkdocs/requirements.txt](.github/mkdocs/requirements.txt) The action will install these dependencies automatically. |
There was a problem hiding this comment.
the requirements.txt will replace the one in the action, so maybe it's worth adding a note that this does not add but rather replaces
README.md
Outdated
| | Input Name | Description | Required | Type | Default | | ||
| | ---------- |----------| -------| ------| ------| | ||
| | GITHUB_TOKEN | GitHub token used for authentication when pushing changes. | true | string | N/A | | ||
| | TAG | Commit, tag, or branch to use for generating GitHub links. | false | string | ${{ github.ref_name }} | |
There was a problem hiding this comment.
I think the TAG has the effect also to generate versions dropdown in the doc page
see here:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR:
docsfolder