Skip to content

Commit 62ea0b3

Browse files
committed
comment the rest of the code
1 parent 9926ddb commit 62ea0b3

File tree

7 files changed

+261
-311
lines changed

7 files changed

+261
-311
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ Thank you for updating SimVascular's documentation.
4747

4848
The SimVascular website user guides can be found in the documentation folder, and the SimVascular website clinical test cases can be found in the clinical folder. In each folder, there are `html` files and their corresponding folder, which share the same name. For example, the folder associated with the `quickguide.html` file is named quickguide.
4949

50+
The JavaScript that adds functionality to the navigation bar and navigation section in the documentation is read from `documentation.js`.
51+
5052
In each folder, there are markdown files from which the content in the `html` files is generated. [Markdown](https://daringfireball.net/projects/markdown) is a lightweight markup language with plain text formatting syntax that can be editied using a text editor.
5153

5254
The markdown files are accessed and translated into `html` with the `<zero-md>` element, which is placed in the `html` file. Documentation on `<zero-md>` can be found [here](https://zerodevx.github.io/zero-md/).
@@ -420,7 +422,7 @@ Try to keep the order of the pages in the Documentation section of the landing p
420422

421423
Thank you for updating SimVascular's landing page.
422424

423-
Unlike the user guide and clinical test case pages, the landing page is written purely in `html` and is not generated from markdown files.
425+
Unlike the user guide and clinical test case pages, the landing page is written purely in `html` and is not generated from markdown files. The JavaScript that adds functionality to the links and gallery in the landing page is read from `home.js`.
424426

425427
The landing page using styling from [Bootstrap](https://getbootstrap.com/), a library for responsive layout because we want the website to be as compatible with mobile devices as possible.
426428

css/additionalinfo.css

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

0 commit comments

Comments
 (0)