2023-06-04 21:23:32 +02:00
|
|
|
# spmenu-wiki
|
2023-01-31 22:34:58 +01:00
|
|
|
|
2023-06-04 21:23:32 +02:00
|
|
|
The official wiki and documentation for [spmenu](https://git.speedie.site/speedie/spmenu).
|
2023-01-31 22:34:58 +01:00
|
|
|
|
2023-06-04 21:23:32 +02:00
|
|
|
## Contributing
|
2023-01-31 22:34:58 +01:00
|
|
|
|
2023-06-04 21:23:32 +02:00
|
|
|
I accept contributions in the form of both new articles and edits to
|
|
|
|
|
existing articles. In the past this was a wiki where anyone could edit
|
|
|
|
|
any page or add new pages, but due to abuse that has since been disabled
|
|
|
|
|
and removed.
|
2023-01-31 22:34:58 +01:00
|
|
|
|
2023-06-04 21:23:32 +02:00
|
|
|
Pages/articles should be written in Markdown, and should be located in
|
|
|
|
|
the `pages/` directory. The sidebar itself can also be found in `pages/`.
|
2023-01-31 22:34:58 +01:00
|
|
|
|
2023-06-04 21:23:32 +02:00
|
|
|
Before submitting your changes, please test locally. If you have `php`
|
|
|
|
|
installed, you can simply do this by running `test.sh` and navigating
|
|
|
|
|
to `localhost:1337` in your web browser.
|
2023-01-31 22:34:58 +01:00
|
|
|
|
2023-06-04 21:23:32 +02:00
|
|
|
When you're done with your changes, fork the project, make any changes
|
|
|
|
|
you wish to make, and submit a pull request using Gitea. I will then
|
|
|
|
|
approve the changes, or request changes to be made to it before it
|
|
|
|
|
can be merged. Please allow some time after the pull request has been
|
|
|
|
|
merged for the changes to be displayed.
|
2023-01-31 22:34:58 +01:00
|
|
|
|
2023-06-04 21:23:32 +02:00
|
|
|
Please note that any documentation is licensed under the
|
2023-06-04 21:25:08 +02:00
|
|
|
CC-BY-SA 4.0 license. The actual code documentation (including all
|
|
|
|
|
PHP) is licensed under the MIT license.
|
