Skip to content

Commit 728c0cd

Browse files
authored
Merge pull request #642 from BlockScience/0.4.3
0.4.3
2 parents f2884fc + 7a550ae commit 728c0cd

19 files changed

+148
-49
lines changed

docs/1 Overview.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

docs/4 JSON Specification.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/CanonicalExamples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Canonical Examples
33
layout: page
4-
nav_order: 4
4+
nav_order: 7
55
---
66

77
As part of MSML, there are multiple canonical examples which are meant to showcase how the library gets used. The table below describes the features that each one has as well as the level of completion for each.

docs/FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FAQ
33
layout: page
4-
nav_order: 6
4+
nav_order: 9
55
---
66

77
The following are frequently asked questions with regards to MSML.

docs/2 GDS Fundamentals.md renamed to docs/GDS Fundamentals.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: GDS Fundamentals
3+
nav_order: 2
4+
layout: page
5+
---
6+
17
# GDS Fundamentals
28

39
For more information with regards to the GDS fundamentals, one can look at this [repository](https://github.com/BlockScience/GDS-MSML-cadCAD). Below is abbreviated documentation describing the fundamentals of Generalized Dynamical Systems (GDS).

docs/GettingStarted.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
22
title: Getting Started
3-
nav_order: 2
3+
nav_order: 4
44
layout: page
55
---
66

77
Getting started with your first MSML specification can seem like a daunting task but this short guide will hopefully make it easier.
88

9+
If you want to view the in-depth JSON specification you can find it here [here](./JSON-Specification/README). This is what is passed to MSML to create the specification object.
10+
911
## 1. Review the Concepts
1012

1113
- Within this documentation, you can find specific technical documentation including the background theory and the components under "Technical Documentation"

docs/3 MSML Enhancements.md renamed to docs/MSML Enhancements.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: MSML Enhancements
3+
nav_order: 3
4+
layout: page
5+
---
6+
17
# MSML Enhancements
28

39
MSML provides certain enhancements beyond the generalized blocks and spaces that can be utilized when building out specifications.

docs/Reports.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Reports
3+
layout: page
4+
nav_order: 6
5+
---
6+
7+
MSML has a variety of reports that can be produced in markdown files which can also be converted to PDF.
8+
9+
## PDF Conversion
10+
11+
- To use PDF conversion, a few other things need to be installed
12+
- One must install pandoc, which can be done with "brew install pandoc" on a mac
13+
- Installing pdflatex might be required which can be done with "brew install --cask basictex" on a mac
14+
- If the pdflatex path is not recognized by the system, you may need to pass the path to it. For example, on a mac this would be: pdflatex_path='/Library/TeX/texbin/pdflatex'

docs/TechnicalDocumentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Technical Documentation
33
layout: page
4-
nav_order: 3
4+
nav_order: 5
55
---
66

77
Placeholder for future documentation on all the technical details of MSML

docs/_config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,10 @@ defaults:
1111
values:
1212
layout: "default"
1313

14+
mermaid:
15+
# Version of mermaid library
16+
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
17+
version: "9.1.3"
18+
1419
aux_links:
1520
MSML Repository Repository: https://github.com/BlockScience/MSML

0 commit comments

Comments
 (0)