librecloud/web
3
2
Fork 0
Code Issues Pull Requests Packages Projects 3 Releases Wiki Activity

Compare commits

base: librecloud:be37734851d3406847486109121b6c07d7a1dc9e
Branches Tags
librecloud:main
...
compare: librecloud:49e38337563de79ddd9ae3cf1b1ec9d1a2e28a6f
Branches Tags
librecloud:main

2 Commits
be37734851 ... 49e3833756

Author SHA1 Message Date
Aidan
49e3833756 docs: add docs editing procedure+guidelines 2025-04-08 16:19:37 -04:00
Aidan
55d441c926
add FUNDING.yml 2025-04-07 19:21:22 -04:00
4 changed files with 54 additions and 2 deletions
Show Stats Expand all files Collapse all files

13
.github/FUNDING.yml vendored Normal file
View File

@ -0,0 +1,13 @@
github: ihatenodejs
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
polar: # Replace with a single Polar username
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
thanks_dev: # Replace with a single thanks.dev username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

1
docs/_sidebar.md
View File

@ -11,3 +11,4 @@
* [Environment Variables](reference/env.md) * [Environment Variables](reference/env.md)
* [Database Migration Guide](reference/db-migration.md) * [Database Migration Guide](reference/db-migration.md)
* [Editing Documentation](reference/editing-docs.md)

2
docs/index.html
View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<title>Document</title> <title>LibreCloud Docs</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description"> <meta name="description" content="Description">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">

38
docs/reference/editing-docs.md Normal file
View File

@ -0,0 +1,38 @@
# Editing Documentation
You can freely modify the LibreCloud documentation on our [repository](https://git.pontusmail.org/librecloud/web), in the `docs/` folder. We encourage contributions of all kinds!
## Editing Guidelines
- Have common sense, please.
- Obviously, this is not the place to rant about your political beliefs or spread hate.
- Test the instructions/docs you write, if possible.
- Yeah, just have common sense
Just be sure to link your new pages in `docs/_sidebar.md` so people can find them!
## Serving Docs
You might want to serve the docs you've edited to see how they'll look on [docs.librecloud.cc](https://docs.librecloud.cc). No fear, Docsify is here!
Do this with the `docsify-cli`, which can be installed like so:
**Bun**
```bash
# This will be installed globally
bun i docsify-cli -g
```
**NPM**
```bash
# This will be installed globally
npm i docsify-cli -g
```
Finally, you can serve the docs with this command:
```bash
docsify serve docs
```