updated docs

This commit is contained in:
Niko Abeler 2022-09-10 15:30:52 +02:00
parent 216291a022
commit fac75dd273
1 changed files with 6 additions and 3 deletions

View File

@ -23,9 +23,8 @@ Each directory in the `/users/` directory of a repository is considered a user.
-- This will be rendered as the blog post. -- This will be rendered as the blog post.
-- Must be present for the blog post to be valid. -- Must be present for the blog post to be valid.
-- All other folders will be ignored -- All other folders will be ignored
\- status.yml \- webmentions.yml
-- Used to track various process status related to the post, -- Used to track incoming and outgoing webmentions
-- such as if a webmention was sent.
\- media/ \- media/
-- Contains all media files used in the blog post. -- Contains all media files used in the blog post.
-- All files in this folder will be publicly available -- All files in this folder will be publicly available
@ -38,6 +37,10 @@ Each directory in the `/users/` directory of a repository is considered a user.
\- VERSION \- VERSION
-- Contains the version string. -- Contains the version string.
-- Used to determine compatibility in the future -- Used to determine compatibility in the future
\- media/
-- All this files will be publicly available. To be used for general files
\- avatar.{png, jpg, jpeg, gif}
-- The avatar for the user
\- config.yml \- config.yml
-- Contains settings global to the user. -- Contains settings global to the user.
-- For example: page title and style options -- For example: page title and style options