State of the art, project management and documentation¶

1.This week's assignment¶

weekly assignment

Build your documentation website describing yourself and your motivation for the textile-academy, including your previous work
Upload the documentation to your project page on class.textile-academy.org
Add references and research based on the topic of your interest
Learn how to upload images, videos, references and how to use markdown and gitlab
Learn to resize and “optimize for web” images, videos and files
EXTRA POINT Customize your website and document how you did it

2. How to build this page¶

SSH Key¶

As I took Fab Academy, I already set all the setting for SSH key and GIT. This is my page for first setting at the Fab Academy.

GIT¶

As I make my documentation on local environment and put it into the server using GIT.

These are list of GIT commands for updating the documents.

Command	meaning
git pull	Get the files from the server
git add .	Add files to the stating area for preparing
git commit -m "message"	register selected changes int he file with the message
git push	Transfer files from local to remote reository
git status	See the current git status

Customize the Zensical theme¶

As fab changes using from MkDocs to Zensical, Zensical is new to me. Instead of using mkdocs.yml, we'll use zensical.toml file. So I've learnt it.

What is zensical?¶

Zensical is the successor of the Mkdocs which is static site generator.

Installation¶

I installed "Zensical" by entering the following commands.

python3 -m venv .venv
source .venv/bin/activate
pip install zensical
zensical build

After I enter these command, this error message appeared;

Error: No config file found in the current folder

So I asked chatGPT to solve this problem. It answered that I should make the zensical project first.

Then I move to the folder where I'd like to work and entered that command for making new zensical project.

zensical new .

Now zencial.toml file was made.

First setting¶

At first, I changed only base color. I changed the follow settings; (I also tried to change the font, I couldn't find "good" font for me, so keep the default setting.)

# For color setting
palette.primary = "custom"
palette.accent = "pink"

#For font setting
[project.theme.font]
# text = "Quicksand"
text = "Montserrat"

Link¶

Week1 in Fab Academy