Skip to content

Homepage

This is the root of the documentation site of the Littil platform. It supports Markdown and PlantUML.

For example: 

@startuml
  Goofy ->  MickeyMouse: calls
  Goofy <-- MickeyMouse: responds
@enduml

Will generate:

Example diagram

You can also include files using:

Dockerfile
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
FROM squidfunk/mkdocs-material

RUN  pip install --no-cache-dir \
     mkdocs-build-plantuml-plugin \
     mkdocs-exclude \
     mkdocs-include-markdown-plugin \
     mkdocs-git-snippet \
     mkdocs-git-revision-date-localized-plugin \
     mkdocs-git-authors-plugin

RUN apk update && apk upgrade && \
    apk add --no-cache gcc musl-dev openjdk11-jdk curl fontconfig ttf-dejavu

RUN mkdir /graphviz && \
  apk add --update graphviz

RUN curl -o plantuml.jar -L http://sourceforge.net/projects/plantuml/files/plantuml.1.2022.5.jar/download && echo "47c95b77e13cd9667ddfc8dc1188ceefac01a109  plantuml.jar" | sha1sum -c - && mv plantuml.jar /opt/plantuml.jar
RUN echo $'#!/bin/sh\n\njava -jar '/opt/plantuml.jar' ${@}' >> /usr/local/bin/plantuml
RUN ["chmod", "+x", "/usr/local/bin/plantuml"]

CMD ["serve", "--dev-addr=0.0.0.0:8000"]

Or even include files from a git repository:

Feature file fetched from a repository
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Feature: Management of the teacher profile
  This feature contains registration, updating and deletion of a user account for teachers, including all profile data

  Scenario: A new user registers on the platform with only mandatory data
    Given user Iris is new to the platform
    When Iris indicates she wants to register as a teacher
    Then she is presented with a registration form
    When she gives her first name as Iris
    And her surname as de Bruin
    And her email as iris.de.bruin@outlook.com
    And her password as superSecret
    And her country as the Netherlands
    And indicates that she agrees with the privacy statement
    And she confirms the registration
    Then she receives an email at iris.de.bruin@outlook.com asking to activate her account
    When she follows the activation instructions in the email
    Then her account is activated
    And she can log in with email iris.de.bruin@outlook.com and password superSecret

  Scenario: A new user registers on the platform, completing her full profile
    Given user Jeffrey is new to the platform
    When Jeffrey indicates he wants to register as a teacher
    Then he is presented with a registration form
    When he gives his first name as Jeffrey
    And his surname as Wang
    And his email as jeffrey.wang@outlook.com
    And his password as superSecret
    And his post code as 3081
    And his country as the Netherlands
    And his available days as Monday,Wednesday,Friday
    And his profile text as Liefst alleen groep acht.
    And indicates that he agrees with the privacy statement
    And he confirms the registration
    Then he receives an email at jeffrey.wang@outlook.com asking to activate his account
    When he follows the activation instructions in the email
    Then his account is activated

Last update: June 29, 2023
Authors: MarcelWildenburg