This commit is contained in:
parent
d51afcdcf6
commit
62eacf879e
1 changed files with 46 additions and 4 deletions
|
@ -10,6 +10,7 @@
|
||||||
- [Global configuration](#global-configuration)
|
- [Global configuration](#global-configuration)
|
||||||
- [Link shortener for contacts](#link-shortener-for-contacts)
|
- [Link shortener for contacts](#link-shortener-for-contacts)
|
||||||
- [Add content](#add-content)
|
- [Add content](#add-content)
|
||||||
|
- [Index](#index)
|
||||||
- [Blog](#blog)
|
- [Blog](#blog)
|
||||||
- [Projects](#projects)
|
- [Projects](#projects)
|
||||||
- [Contacts](#contacts)
|
- [Contacts](#contacts)
|
||||||
|
@ -138,9 +139,27 @@ option: value
|
||||||
Markdown file
|
Markdown file
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Index
|
||||||
|
|
||||||
|
Markdown file is stored in `/app/data/index.md`
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
name: Option<String>
|
||||||
|
pronouns: Option<String>
|
||||||
|
avatar: Option<String>
|
||||||
|
avatar_caption: Option<String>
|
||||||
|
---
|
||||||
|
|
||||||
|
Index content
|
||||||
|
```
|
||||||
|
|
||||||
|
- If no `name`, the `fullname` used in the configuration will be used
|
||||||
|
- `avatar` is the link of the avatar
|
||||||
|
|
||||||
## Blog
|
## Blog
|
||||||
|
|
||||||
Markdown files are stored in `/app/data/blog/`
|
Markdown files are stored in `/app/data/blog/posts/`
|
||||||
|
|
||||||
```
|
```
|
||||||
---
|
---
|
||||||
|
@ -157,11 +176,15 @@ Post content
|
||||||
- If no `title`, the filename will be used
|
- If no `title`, the filename will be used
|
||||||
- `date` format is `day-month-year`
|
- `date` format is `day-month-year`
|
||||||
- `publish` is default to false. When false, posts are hidden from index
|
- `publish` is default to false. When false, posts are hidden from index
|
||||||
but accessible, see #30
|
but accessible, see [#30](https://git.mylloon.fr/Anri/mylloon.fr/issues/30)
|
||||||
|
|
||||||
|
### About <!-- omit in toc -->
|
||||||
|
|
||||||
|
The file is stored at `/app/data/blog/about.md`.
|
||||||
|
|
||||||
## Projects
|
## Projects
|
||||||
|
|
||||||
Markdown files are stored in `/app/data/projects/`
|
Markdown files are stored in `/app/data/projects/apps/`
|
||||||
|
|
||||||
```
|
```
|
||||||
---
|
---
|
||||||
|
@ -176,7 +199,14 @@ Project description
|
||||||
|
|
||||||
- If no `link` : the div won't be clickable and will be reported as is to the user
|
- If no `link` : the div won't be clickable and will be reported as is to the user
|
||||||
(no corner-arrow)
|
(no corner-arrow)
|
||||||
- Note that only a handful of [`language`s are supported](./static/css/languages.css).
|
- Note that only a handful of [`language`s are supported](./static/css/languages.css)
|
||||||
|
|
||||||
|
You can also put apps in an "Archived" category, in this case, store markdown
|
||||||
|
files in `archive` subdirectory of `apps`.
|
||||||
|
|
||||||
|
### About <!-- omit in toc -->
|
||||||
|
|
||||||
|
The file is stored at `/app/data/projects/about.md`.
|
||||||
|
|
||||||
## Contacts
|
## Contacts
|
||||||
|
|
||||||
|
@ -204,3 +234,15 @@ Custom project description
|
||||||
- `user` is the username used in the platform
|
- `user` is the username used in the platform
|
||||||
- `description` will be rendered as HTML "title" (text will appear when cursor
|
- `description` will be rendered as HTML "title" (text will appear when cursor
|
||||||
is hover the link)
|
is hover the link)
|
||||||
|
|
||||||
|
Also, contacts are categorized, here is the list of the available categories:
|
||||||
|
|
||||||
|
- `socials`
|
||||||
|
- `forges`
|
||||||
|
- `others`
|
||||||
|
|
||||||
|
For example, `socials` contact files are stored in `/app/data/contacts/socials/`.
|
||||||
|
|
||||||
|
### About <!-- omit in toc -->
|
||||||
|
|
||||||
|
The file is stored at `/app/data/contacts/about.md`.
|
||||||
|
|
Loading…
Reference in a new issue