Skip to content

Commit cba4216

Browse files
committed
Markdown in INSTALL.md, change styling, and docgen tutorial/test.
1 parent 9c42290 commit cba4216

4 files changed

Lines changed: 374 additions & 15 deletions

File tree

INSTALL.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -522,6 +522,9 @@ proceed to [install EasyCrypt from Source](#installing-easycrypt-from-source).
522522
- [OCaml ini-files](https://opam.ocaml.org/packages/ocaml-inifiles/) (version >= 1.2)
523523
Additional resources:
524524
- http://archive.ubuntu.com/ubuntu/pool/universe/o/ocaml-inifiles
525+
- [OCaml Markdown](https://github.com/gildor478/ocaml-markdown)
526+
Additional resources:
527+
- https://opam.ocaml.org/packages/markdown
525528
- [Python3](https://www.python.org/downloads)
526529
You also need to install the following libraries:
527530
- [Python3 YAML](https://pyyaml.org/wiki/PyYAMLDocumentation)

resources/.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +0,0 @@
1-
/tests/

resources/styles/styles.css

Lines changed: 63 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,80 @@
11
/* General Styling */
2+
/* Body */
23
body {
3-
font-family: Arial, sans-serif;
4+
font-family: "-apple-system", "BlinkMacSystemFont", "Roboto", "Helvetica Neue", "Arial", sans-serif;
5+
line-height: 1.2;
6+
font-size: 16px;
47
margin: 0;
58
padding: 0;
69
color: #333;
710
background-color: #f9f9f9;
811
}
912

10-
h1, h2 {
11-
color: #444;
13+
/* Code blocks */
14+
pre {
15+
font-family: "Fira Code", "Consolas", monospace;
16+
font-size: 1rem;
17+
padding: 5px;
18+
border-radius: 1px;
19+
color: #2d2d2d;
20+
background-color: #ecf0f1;
21+
}
22+
23+
/* Inline code */
24+
code {
25+
font-family: "Fira Code", "Consolas", "Courier New", monospace;
26+
font-size: 1rem;
27+
color: #d6336c;
1228
}
1329

14-
p, pre {
15-
margin: 0.5em 0;
30+
/* Headings */
31+
h1, h2, h3, h4, h5, h6 {
32+
font-family: "Roboto", "Arial", sans-serif;
33+
font-weight: 600;
34+
color: #1a1a1a;
35+
margin-bottom: 0.5em;
1636
}
1737

38+
h1 {
39+
font-size: 2.25rem;
40+
}
41+
h2 {
42+
font-size: 2rem;
43+
}
44+
h3 {
45+
font-size: 1.75rem;
46+
}
47+
h4 {
48+
font-size: 1.5rem;
49+
}
50+
h5 {
51+
font-size: 1.25rem;
52+
}
53+
h6 {
54+
font-size: 1rem;
55+
}
56+
57+
/* Links */
1858
a {
59+
font-family: "Roboto", "Arial", sans-serif;
60+
color: #007bff;
1961
text-decoration: none;
20-
color: #0066cc;
2162
}
2263

2364
a:hover {
65+
color: #0056b3;
2466
text-decoration: underline;
2567
}
2668

27-
/* Sidebar Styling */
69+
.serif-text {
70+
font-family: "Times New Roman", "Times", serif;
71+
font-size: 1rem;
72+
color: #333;
73+
}
74+
75+
/* Specific styling */
76+
77+
/* Sidebar */
2878
.sidebar {
2979
width: 200px;
3080
background-color: #2c3e50;
@@ -76,7 +126,7 @@ a:hover {
76126
font-weight: bold;
77127
}
78128

79-
/* Main Content Styling */
129+
/* Main content */
80130
main {
81131
margin-left: 220px;
82132
padding: 20px;
@@ -99,7 +149,7 @@ main {
99149
font-size: 1.2em;
100150
}
101151

102-
/* Section Styling */
152+
/* Sections */
103153
.item-section {
104154
margin-bottom: 40px;
105155
}
@@ -111,7 +161,7 @@ main {
111161
margin-bottom: 20px;
112162
}
113163

114-
/* Item List Styling */
164+
/* Item lists */
115165
.item-list {
116166
list-style: none;
117167
padding: 0;
@@ -163,17 +213,16 @@ main {
163213
margin-top: 10px;
164214
}
165215

166-
/* Code Block Styling */
216+
/* Source code */
167217
pre.source {
168-
background-color: #ecf0f1;
169-
border: 1px solid #bdc3c7;
218+
border: 2px solid #bdc3c7;
170219
padding: 10px;
171220
border-radius: 5px;
172221
overflow-x: auto;
173222
white-space: pre-wrap;
174223
}
175224

176-
/* Introduction Section Styling */
225+
/* Introduction section */
177226
.intro-section {
178227
margin-bottom: 40px;
179228
}

0 commit comments

Comments
 (0)