Skip to content

Project structure

Eric Miguel edited this page Feb 13, 2021 · 3 revisions

General

Page navigation elements are generated using the data structures stored in the yml files at _data folder.

Model technical articles are stored at articles folder.

Navigation

There just to types of navigation elements

  1. top navigation: shown at the top on to every page, except the home/ landing page
  2. context navigation: shown at every model technical article, as a content index

You can use the above samples to create new navigation elements.

Top navigation

General menu, displaying drop-downs to deterministic, probabilistic and wave models.

- name: Simple nav item
  link: /#
- name: Dropdown nav item
  dropdown:
    - name: dropdown item 1
      link: /#
    - name: dropdown item 2
      link: /#

Article context navigation

Serves as content index. Thus, link keys this yml must address to ids in the page.

- label: Example context navigation
  items:
    - name: Introduction
      link: /#
    - name: Grid
      link: /#
      items:
        - name: Vertical grid
          link: /#vertical-grid
        - name: Horizontal grid
          link: /#horizontal-grid

Articles

The technical articles are the heart of any encyclopedia.

  • Each model must have it`s own markdown file
  • The markdown file must be named with the name of the model

There is no rigid structure to articles pages.

Clone this wiki locally