Skip to content

Commit 4303583

Browse files
committed
latex works
1 parent b5fb51e commit 4303583

7 files changed

Lines changed: 76 additions & 15 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<br />
88

9-
<div align="center">
9+
<div align="center" markdown="1">
1010

1111
[![g++](https://github.com/SpectraL519/cpp-gl/actions/workflows/gpp.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/g++)
1212
[![clang++](https://github.com/SpectraL519/cpp-gl/actions/workflows/clang.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/clang++)

docs/index.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
--8<-- "README.md"
1+
<div align="center" markdown="1">
2+
<img src="img/cpp-gl-hex.png" alt="CPP-GL" width="360" />
3+
</div>
4+
5+
<br />
6+
7+
<div align="center" markdown="1">
8+
9+
[![g++](https://github.com/SpectraL519/cpp-gl/actions/workflows/gpp.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/g++)
10+
[![clang++](https://github.com/SpectraL519/cpp-gl/actions/workflows/clang.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/clang++)
11+
[![format](https://github.com/SpectraL519/cpp-gl/actions/workflows/format.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/format)
12+
[![benchmarks](https://github.com/SpectraL519/cpp-gl/actions/workflows/benchmarks.yaml/badge.svg)](https://github.com/SpectraL519/cpp-gl/actions/workflows/benchmarks.yaml)
13+
14+
</div>
15+
16+
<br />
17+
18+
## Overview
19+
20+
{% include-markdown "../README.md" start="## Overview" %}

docs/scripts/mathjax.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
window.MathJax = {
22
tex: {
33
inlineMath: [["\\(", "\\)"]],
4-
displayMath: [["\\[", "\\]"]],
4+
displayMath: [["\\[", "\\]"], ["[[", "]]"]],
55
processEscapes: true,
66
processEnvironments: true
77
},

include/gl/graph.hpp

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,16 @@ struct to_impl;
7979
/// Big-O: \f$\mathcal{O}(|V| + |E|)\f$
8080
///
8181
/// Display math:
82-
/// ```math
82+
///
83+
/// \f$
8384
/// \sum_{v \in V} \text{deg}(v) = 2 |E|
84-
/// ```
85+
/// \f$
8586
///
8687
/// Complex environment:
87-
/// ```math
88+
///
89+
/// \f$
8890
/// A_{i,j} = \begin{cases} 1 & \text{if } (i,j) \in E \\ 0 & \text{otherwise} \end{cases}
89-
/// ```
91+
/// \f$
9092
///
9193
/// ### Code Example
9294
/// ```cpp

mkdocs.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@ site_name: CPP-GL
22
site_description: "General-purpose Template Graph and Hypergraph Library for Modern C++"
33
repo_url: "https://github.com/SpectraL519/cpp-gl"
44

5+
nav:
6+
- Home: index.md
7+
- CPP-GL API:
8+
- Namespaces: cpp-gl/namespaces.md
9+
- Classes & Structs: cpp-gl/annotated.md
10+
- Files: cpp-gl/files.md
11+
512
theme:
613
name: material
7-
logo: docs/img/cpp-gl-hex.png
8-
favicon: docs/img/cpp-gl-hex.png
14+
logo: img/cpp-gl-hex.png
15+
favicon: img/cpp-gl-hex.png
916
features:
1017
- navigation.tabs
1118
- navigation.sections
@@ -60,9 +67,5 @@ extra_javascript:
6067
- https://polyfill.io/v3/polyfill.min.js?features=es6
6168
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
6269

63-
nav:
64-
- Home: index.md
65-
- CPP-GL API:
66-
- Namespaces: cpp-gl/namespaces.md
67-
- Classes & Structs: cpp-gl/annotated.md
68-
- Files: cpp-gl/files.md
70+
# extra_css:
71+
# - style/logo.css

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ requires-python = ">=3.14"
77
dependencies = [
88
"mkdocs>=1.6.1",
99
"mkdocs-callouts>=1.16.0",
10+
"mkdocs-include-markdown-plugin>=7.2.2",
1011
"mkdocs-material>=9.7.6",
1112
"mkdoxy>=1.2.8",
1213
]

uv.lock

Lines changed: 36 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)