Skip to content

Commit

Permalink
docs(docs): add clickable flow chart
Browse files Browse the repository at this point in the history
  • Loading branch information
kantord committed Mar 2, 2021
1 parent 1342631 commit fe5d9bb
Show file tree
Hide file tree
Showing 4 changed files with 208 additions and 23 deletions.
25 changes: 25 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,31 @@ This project exists to create a beginner-friendly, community-oriented,
free software licensed language learning application. If you want to learn more
about LibreLingo's background, [I recommend reading my article](https://dev.to/kantord/why-i-built-librelingo-280o).

## Project structure

### Clickable flow chart
``` mermaid
graph LR
YAML[YAML course] --> LOAD
LOAD[librelingo-yaml-loader] --> EXPORT[librelingo-json-export]
EXPORT -->|JSON files| APP
LOAD -->|TODO| AUDIO
LOAD -->|TODO| IMAGE
AUDIO[Audio files] --> APP
IMAGE[Image files] --> APP
TYPES[librelingo-types] --> LOAD
UTILS[librelingo-utils] --> LOAD
click APP "https://github.com/kantord/LibreLingo/tree/main/apps/web"
click EXPORT "https://pypi.org/project/librelingo-json-export/"
click UTILS "https://pypi.org/project/librelingo-utils/"
click TYPES "https://pypi.org/project/librelingo-types/"
click IMAGE "https://github.com/kantord/LibreLingo/tree/main/apps/web/static/images"
click AUDIO "https://github.com/kantord/LibreLingo/tree/main/apps/web/static/voice"
click LOAD "https://pypi.org/project/librelingo-yaml-loader/"
click YAML "https://github.com/kantord/LibreLingo/tree/main/courses"
```

## Setting up the development environment

Clone the repository:
Expand Down
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ theme:
name: material
palette:
primary: #325f74;

plugins:
- search
- mermaid2
Loading

1 comment on commit fe5d9bb

@vercel
Copy link

@vercel vercel bot commented on fe5d9bb Mar 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.