https://github.com/fu-sen/neocities-mkdocs

📃 MkDocs with 😺 Neocities (minimal configuration)
https://github.com/fu-sen/neocities-mkdocs

github-actions mkdocs neocities

Last synced: 2 months ago
JSON representation

📃 MkDocs with 😺 Neocities (minimal configuration)

• Host: GitHub
• URL: https://github.com/fu-sen/neocities-mkdocs
• Owner: fu-sen
• Created: 2022-06-13T05:22:07.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-21T06:51:24.000Z (10 months ago)
• Last Synced: 2024-04-21T07:33:47.381Z (10 months ago)
• Topics: github-actions, mkdocs, neocities
• Homepage: https://mkdocsgit.neocities.org
• Size: 3.91 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


## Neocities-MkDocs

**MkDocs with Neocities (minimal configuration)**

- [Neocities](https://neocities.org/)

- [MkDocs](https://www.mkdocs.org/)

## How to use

1. Edit `mkdocs.yml` and `docs/index.md`, add more files if needed.

2. Add the pip package to `requirements.txt` . (Themes and plugins)

3. Log in to Neocities and select `Settings`.

4. Select `Manage Site Settings` in` Manage Sites`.

5. Select `Generate API Key` in` API Key`. 

6. The API Key will be displayed, so save this text string.

7. Select `Settings` for your GitHub project.

8. Select `Actions` in `Secrets`.

9. Select `New repository secrets`.

10. Enter `NEOCITIES_API_KEY` in Name and API Key in Value.

11. Commit to a GitHub project: `git push`

## Build error

Many of the build error are that you mistyped `mkdocs.yml`

or you forgot to add the package to` requirements.txt`.

Check the file change immediately before the error occurred.

This is often not a problem with this project.

You should not open an issue for that.