Skip to content

1. State of the art, project management and documentation

This week at Fabric Academy we learned how to use Github to document our projects.This platform allows us to edit our webpage using Markdown language. We also learned about different softwares that allow us to edit and modify images.

BASICS

Mattermost -> open source chat tool

Gitlab -> repo like GitHub or Bitbucket

Mkdocs -> static site generator with markdown language

Nueval -> evaluation tool to track progress and discuss feedback

Mkdocs lenguage

Changing The Design of the Interface MkDocs supports Google's original color palette;

For the text , choose raleway through the website Google Fonts

Adding Images and Links

#For general image insert
![O](images/assignment01/small_logo.jpg)

#To adjust width
<img src="../images/week1/commit.jpg" alt="Runway4" width="400" style="display:inline-block;" />

#To adjust width and alignment.
<img align="right" src="images/assignment01/work_lemongrass_s2.jpg" width="50%">


  • TinyPNG reduce the file size of your WEBP, JPEG and PNG files wihout losing quality.
  • I personally use Adobe in order to make collages, edits...

Tables

1 | 2 | 3
--- | --- | ---
*INFO* | `INFO` | **INFO**
1 | 2 | 3
1 2 3
INFO INFO INFO
1 2 3

Blockquotes

> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.

Code and Syntax Highlighting

Inline `code` has `back-ticks around` it.

Inline code has back-ticks around it.

Code For Changing your logo

  features:
    # See more about the navigation at https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
  favicon: images/logoicon.png
  logo: images/logoicon.png

Headings & Breaks

```ruby # h1 Heading

h2 Heading

h3 Heading

h4 Heading

Horizontal Rules

```

For more info check Material for Mkdocs Link

  1. Spacing paragraphs

I used the HTML code line <br> to create spaces between paragraphs which can also be used to start a new line using the codeline <br>


  1. Adding a space between images or text

You can use any of the following code lines: * &nbsp; * &ensp; * &emsp;


Saving final changes

Runway4 Runway4

Last update: 2021-12-21
Back to top