Skip to content

Commit e44a1ef

Browse files
ChrisComptonChrisCompton
committed
Revise content.
1 parent 619ba60 commit e44a1ef

File tree

8 files changed

+150
-10
lines changed

8 files changed

+150
-10
lines changed

‎docs/credits.md

+117-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,118 @@
11

2-
https://github.com/squidfunk/mkdocs-material
3-
Copyright (c) 2016-2024 Martin Donath <[email protected]>
2+
## MkDocs
3+
4+
=== "Acknowledgment"
5+
6+
This project uses MkDocs to manage and produce the content and site.
7+
8+
- [MkDocs](https://www.mkdocs.org/)
9+
- [GitHub Project](https://github.com/mkdocs/mkdocs)
10+
11+
> Copyright © 2014, Tom Christie. All rights reserved.
12+
13+
=== "License"
14+
15+
```
16+
Copyright © 2014-present, Tom Christie. All rights reserved.
17+
18+
Redistribution and use in source and binary forms, with or
19+
without modification, are permitted provided that the following
20+
conditions are met:
21+
22+
Redistributions of source code must retain the above copyright
23+
notice, this list of conditions and the following disclaimer.
24+
Redistributions in binary form must reproduce the above copyright
25+
notice, this list of conditions and the following disclaimer in
26+
the documentation and/or other materials provided with the
27+
distribution.
28+
29+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30+
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31+
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
32+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
33+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
34+
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
36+
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
37+
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
38+
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
39+
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
40+
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41+
POSSIBILITY OF SUCH DAMAGE.
42+
```
43+
44+
---
45+
46+
## Material for MkDocs
47+
48+
=== "Acknowledgment"
49+
50+
This project uses the Material for MkDocs theme as the basis of the notebook.
51+
52+
- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
53+
- [GitHub Project](https://github.com/squidfunk/mkdocs-material)
54+
55+
> Copyright (c) 2016-2024 Martin Donath <[email protected]>
56+
57+
=== "License"
58+
59+
```
60+
Copyright (c) 2016-2024 Martin Donath <[email protected]>
61+
62+
Permission is hereby granted, free of charge, to any person obtaining a copy
63+
of this software and associated documentation files (the "Software"), to
64+
deal in the Software without restriction, including without limitation the
65+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
66+
sell copies of the Software, and to permit persons to whom the Software is
67+
furnished to do so, subject to the following conditions:
68+
69+
The above copyright notice and this permission notice shall be included in
70+
all copies or substantial portions of the Software.
71+
72+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
73+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
74+
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
75+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
76+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
77+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
78+
IN THE SOFTWARE.
79+
```
80+
81+
---
82+
83+
## Marp Markdown Presentation Ecosystem
84+
85+
=== "Acknowledgment"
86+
87+
This project uses Marp to create the HTML and PDF presentations.
88+
89+
- [Marp](https://marp.app/)
90+
- [GitHub Project](https://github.com/marp-team/marp)
91+
92+
> Copyright (c) 2018-2023 Marp team ([email protected])
93+
94+
=== "License"
95+
96+
```
97+
MIT License
98+
99+
Copyright (c) 2018-2023 Marp team ([email protected])
100+
101+
Permission is hereby granted, free of charge, to any person obtaining a copy
102+
of this software and associated documentation files (the "Software"), to deal
103+
in the Software without restriction, including without limitation the rights
104+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
105+
copies of the Software, and to permit persons to whom the Software is
106+
furnished to do so, subject to the following conditions:
107+
108+
The above copyright notice and this permission notice shall be included in all
109+
copies or substantial portions of the Software.
110+
111+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
112+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
113+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
114+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
115+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
116+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
117+
SOFTWARE.
118+
```

‎docs/index.md

+24-5
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,38 @@
11

22

3-
# Welcome to MkDocs
3+
# Welcome to the Notebook
44

5-
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
5+
For full documentation visit [chriscompton.github.io/notebook](https://chriscompton.github.io/notebook/).
66

7-
## Commands
7+
## MkDocs Commands
88

9-
* `mkdocs new [dir-name]` - Create a new project.
109
* `mkdocs serve` - Start the live-reloading docs server.
1110
* `mkdocs build` - Build the documentation site.
12-
* `mkdocs -h` - Print help message and exit.
11+
12+
## Marp Commands
13+
14+
* `python scripts/marp.py` - Generate presentations when front matter has `marp: true`
15+
16+
!!! note
17+
18+
The **marp script will alter your markdown files** to add buttons at the bottom of the page for
19+
HTML and PDF. If you change `marp: false`, it will cause the script to remove the links and
20+
the generated files.
1321

1422
## Project layout
1523

1624
mkdocs.yml # The configuration file.
25+
scripts/
26+
marp.py # Scans for markdown files requiring presentations.
27+
encode.py # Converts the png template images to css embeddable images.
28+
marp/
29+
notebook/
30+
image/ # Has the png background images for presentations.
31+
notebook.css # The CSS file used for presentation formatting.
1732
docs/
1833
index.md # The documentation homepage.
1934
... # Other markdown pages, images and other files.
35+
36+
## Formatting
37+
38+
You can find great documentation on formatting content at the [mkdocs-material reference](https://squidfunk.github.io/mkdocs-material/reference/).

‎docs/static/css/adjust.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
/* Sets a common highlight color */
2+
/* Sets a common highlight color
33
.md-content a {
44
color: #00833d;
55
}

‎marp/images/content.png ‎marp/notebook/images/content.png

File renamed without changes.

‎marp/images/topic.png ‎marp/notebook/images/topic.png

File renamed without changes.

‎marp/notebook.css ‎marp/notebook/notebook.css

File renamed without changes.

‎mkdocs.yml

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
site_name: Notebook
2+
# docs_dir: ../your_docs_dir
23
repo_url: https://github.com/ChrisCompton/notebook
34
theme:
45
name: material
6+
palette:
7+
primary: green
58

69
plugins:
710
- search
@@ -54,4 +57,7 @@ markdown_extensions:
5457
exclude_docs: |
5558
__*.md
5659
draft_docs: |
57-
DRAFT_*.md
60+
DRAFT_*.md
61+
62+
extra:
63+
generator: false

‎scripts/config.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
markdown_source_path = 'docs'
2-
marp_theme_path = 'marp'
2+
marp_theme_path = 'marp/notebook'
33
marp_theme_image_path = 'marp/images'

0 commit comments

Comments
 (0)