xenobyte/sukaato-site
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Changed hypothetical shell variable to futureproof documentation, removed link to gitignored image

Browse Source
This commit is contained in:
Alex Tavarez
2025-09-06 23:14:59 -04:00
parent e8232ee713
commit b5a96c7940
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -1,7 +1,5 @@
# Sukaato
![project-logo](/priv/static/images/main.svg)
This repository is to define a backend for, and to serve, my website. The code here is building upon the basis of a project structure and associated source code supplied by the [Elxir](https://elixir-lang.org/) [Phoenix](https://hexdocs.pm/phoenix/installation.html) web framework package(s)/module(s) and the associated CLI utilities.
This project is a WIP.
@@ -14,29 +12,29 @@ There are a collection of procedures to follow for proper execution and installa
#### Configure `site.toml`
Make sure to configure things like the website's name, author, etc., via the `${project_root}/site.toml` file.
Make sure to configure things like the website's name, author, etc., via the `${SUKAATO_SITE_SOURCE_ROOT}/site.toml` file.
#### Supplying Resources to Themes
Make sure that subdirectories under path `${project_root}/priv/static/` are appropriately populated. Either follow the active/enabled theme's CSS/SASS path references, or change such path references to match custom `${project_root}/priv/static` prefixed filepaths.
Make sure that subdirectories under path `${SUKAATO_SITE_SOURCE_ROOT}/priv/static/` are appropriately populated. Either follow the active/enabled theme's CSS/SASS path references, or change such path references to match custom `${SUKAATO_SITE_SOURCE_ROOT}/priv/static` prefixed filepaths.
> [!TIP]
> Website theme can be changed by assigning a value to `theme` in `${project_root}/site.toml`.
> Website theme can be changed by assigning a value to `theme` in `${SUKAATO_SITE_SOURCE_ROOT}/site.toml`.
References to paths in CSS/SASS file should be absolute paths, insofar as their root is kwown and is `${project_root}/priv/static`. That is, they are relative to the aforementioned path, but not relative to the CSS/SASS file being currently edited.
References to paths in CSS/SASS file should be absolute paths, insofar as their root is kwown and is `${SUKAATO_SITE_SOURCE_ROOT}/priv/static`. That is, they are relative to the aforementioned path, but not relative to the CSS/SASS file being currently edited.
> [!WARNING]
> The paths referenced in CSS/SASS files recursively under `${project_root}/assets/sass/` or `${project_root}/assets/css/` are relative to `${project_root}/priv/static` and not each CSS/SASS file currently being edited. This is UNLESS subdirectories of `${project_root}/priv/static/` [have not been marked as external in `${project_root}/config/config.exs`](https://hexdocs.pm/phoenix/asset_management.html#images-fonts-and-external-files); in that case, the given filepaths will never be found anyway.
> The paths referenced in CSS/SASS files recursively under `${SUKAATO_SITE_SOURCE_ROOT}/assets/sass/` or `${SUKAATO_SITE_SOURCE_ROOT}/assets/css/` are relative to `${SUKAATO_SITE_SOURCE_ROOT}/priv/static` and not each CSS/SASS file currently being edited. This is UNLESS subdirectories of `${SUKAATO_SITE_SOURCE_ROOT}/priv/static/` [have not been marked as external in `${SUKAATO_SITE_SOURCE_ROOT}/config/config.exs`](https://hexdocs.pm/phoenix/asset_management.html#images-fonts-and-external-files); in that case, the given filepaths will never be found anyway.
SASS files can be found under path `${project_root}/assets/sass/themes/**/`, while CSS files can be found under path `${project_root}/assets/css/`.
SASS files can be found under path `${SUKAATO_SITE_SOURCE_ROOT}/assets/sass/themes/**/`, while CSS files can be found under path `${SUKAATO_SITE_SOURCE_ROOT}/assets/css/`.
> [!TIP]
> Avoid editing file `app.css` under `${project_root}/assets/css/` path directly. Edit SASS files under `${project_root}/assets/sass/themes/${theme_name}/` wherein `$theme_name` corresponds to name of enabled/active website theme. The aforementioned `app.css` file should be the final output starting from the preprocessing of SASS files recursively found under any subdirectory at `${project_root}/assets/sass/themes/`. Which subdirectory's SASS files are to be preprocessed as CSS is based on the relative imports in a symbolic link, `app.sass`, directly under `${project_root}/assets/sass/themes/`. This symbolic link should be to an `export.sass` file found directly under `${project_root}/assets/sass/themes/${theme_name}/` corresponding to the active/enabled website theme.
> Avoid editing file `app.css` under `${SUKAATO_SITE_SOURCE_ROOT}/assets/css/` path directly. Edit SASS files under `${SUKAATO_SITE_SOURCE_ROOT}/assets/sass/themes/${theme_name}/` wherein `$theme_name` corresponds to name of enabled/active website theme. The aforementioned `app.css` file should be the final output starting from the preprocessing of SASS files recursively found under any subdirectory at `${SUKAATO_SITE_SOURCE_ROOT}/assets/sass/themes/`. Which subdirectory's SASS files are to be preprocessed as CSS is based on the relative imports in a symbolic link, `app.sass`, directly under `${SUKAATO_SITE_SOURCE_ROOT}/assets/sass/themes/`. This symbolic link should be to an `export.sass` file found directly under `${SUKAATO_SITE_SOURCE_ROOT}/assets/sass/themes/${theme_name}/` corresponding to the active/enabled website theme.
The website has a default theme supplied, but you are welcome to make your own and then set it in `${project_root}/site.toml`.
The website has a default theme supplied, but you are welcome to make your own and then set it in `${SUKAATO_SITE_SOURCE_ROOT}/site.toml`.
> [!TIP]
> Make sure that all renderable stylesheet paths for files under `${project_root}/lib/sukaato_web/controllers/page_*` are set to `/assets/app.css`, or a path relative to `${project_root}/priv/static` that has been made external (whether the directory exists yet or not). Again, see about [asset management in Phoenix web framework](https://hexdocs.pm/phoenix/asset_management.html#images-fonts-and-external-files).
> Make sure that all renderable stylesheet paths for files under `${SUKAATO_SITE_SOURCE_ROOT}/lib/sukaato_web/controllers/page_*` are set to `/assets/app.css`, or a path relative to `${SUKAATO_SITE_SOURCE_ROOT}/priv/static` that has been made external (whether the directory exists yet or not). Again, see about [asset management in Phoenix web framework](https://hexdocs.pm/phoenix/asset_management.html#images-fonts-and-external-files).
### Running this project's server