Skip to content

Commit a3c34b8

Browse files
authored
Enhance Linear Algebra Documentation Structure and Navigation (#5)
* Enhance documentation structure and navigation - Add logo.png to assets directory for automatic Documenter.jl integration - Remove navigation section from index.md and create dedicated sites.md page - Update sites.md to reflect Linear Algebra as current site - Add sites.md to pages list in make.jl for proper sidebar inclusion - Improve documentation organization following Math_Foundations pattern * Add LiveServer dependency for local documentation testing - Add LiveServer package to project dependencies - Enables local documentation preview with julia --project=. -e 'using LiveServer; serve(dir="docs/build", port=8001)' - Facilitates development workflow for documentation changes
1 parent 646384c commit a3c34b8

File tree

5 files changed

+15
-23
lines changed

5 files changed

+15
-23
lines changed

Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
99
LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
1010
Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
1111
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
12+
LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
1213
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
1314
RationalRoots = "308eb6b3-cc68-5ff3-9e97-c3c4da4fa681"
1415
Reexport = "189a3867-3050-52da-a836-e630ba90ab69"

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ makedocs(;
88
sitename = "Linear_Algebra",
99
# This argument is only so that the sequence of pages in the sidebar is configured
1010
# By default all markdown files in `docs/src` are expanded and included.
11-
pages = ["index.md"],
11+
pages = ["index.md", "sites.md"],
1212
# Don't worry about what `CI` does in this line.
1313
format = Documenter.HTML(
1414
prettyurls = CI,

docs/src/assets/logo.png

31.4 KB
Loading

docs/src/index.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,4 @@ This section provides the documentation for all the linear algebra functions.
1010
Modules = [Linear_Algebra]
1111
Order = [:function, :type]
1212
Pages = ["linear_algebra_basic.jl", "linear_algebra_transform.jl"]
13-
```
14-
15-
---
16-
17-
## Navigating FourM Study Guides & Documentation Sites
18-
19-
```@raw html
20-
<div class="site-navigation">
21-
<div class="nav-section">
22-
<h4>Documentation Sites</h4>
23-
<ul>
24-
<li><a href="https://study.fourm.info/linear_algebra/">Linear Algebra Docs (this site)</a></li>
25-
<li><a href="https://study.fourm.info/math_foundations/">Math Foundations Docs</a></li>
26-
</ul>
27-
</div>
28-
<div class="nav-section">
29-
<h4>Related Projects</h4>
30-
<ul>
31-
<li><a href="https://study.fourm.info/">Main Study Site</a></li>
32-
</ul>
33-
</div>
34-
</div>
3513
```

docs/src/sites.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# FourM Study Guides & Documentation Sites
2+
3+
This site is one of several documentation sites for my personal math and technology study under what I call the FourM project. It is essentially a collection of resources I created to understand various mathematical concepts and software frameworks.
4+
5+
The main sites can be found at:
6+
7+
- [Main Study Site](https://study.fourm.info/)
8+
- [FourM GitHub Repository](https://github.com/fourm)
9+
10+
Here are some of the key documentation sites related to my mathematics study:
11+
12+
- [Linear Algebra Docs - the current site (this site)](https://study.fourm.info/linear_algebra/)
13+
- [Math Foundations Docs](https://study.fourm.info/math_foundations/)

0 commit comments

Comments
 (0)