Browse Source

demo: fix typo

George Cushen 6 years ago
parent
commit
5b4d11825e
2 changed files with 17 additions and 3 deletions
  1. 4 0
      assets/sass/academic/_root.scss
  2. 13 3
      exampleSite/content/post/writing.md

+ 4 - 0
assets/sass/academic/_root.scss

@@ -55,6 +55,10 @@ ul, ol, dl {
   margin-bottom: 1rem;
 }
 
+ul.task-list {
+  list-style: none;
+}
+
 /* Navigation bar text */
 .navbar-light {
   font-family: $sta-font-nav, sans-serif;

+ 13 - 3
exampleSite/content/post/writing.md

@@ -7,7 +7,7 @@ diagram: true
 
 Academic is designed to give technical content creators a seamless experience. You can focus on the content and Academic handles the rest.
 
-Highlight your code snippets, take notes on math classes, and draw diagrams from textual representation.
+**Highlight your code snippets, take notes on math classes, and draw diagrams from textual representation.**
 
 On this page, you'll find some examples of the types of technical content that can be rendered with Academic.
 
@@ -46,12 +46,14 @@ Note that math blocks should be wrapped with `<div>...</div>` and inline math wr
 $$</div>
 ```
 
-renders as `$\gamma_{n} = \frac{\mathbf x_{n}}{y}$`  $\gamma_{n} = \frac{\mathbf x_{n}}{y}$
+renders as
 
 <div>
 $$\gamma_{n} = \frac{ \left | \left (\mathbf x_{n} - \mathbf x_{n-1} \right )^T \left [\nabla F (\mathbf x_{n}) - \nabla F (\mathbf x_{n-1}) \right ] \right |}{\left \|\nabla F(\mathbf{x}_{n}) - \nabla F(\mathbf{x}_{n-1}) \right \|^2}$$
 </div>
 
+Or inline math like *\`$\gamma_{n} = \frac{\mathbf x_{n}}{y}$\`* renders as `$\gamma_{n} = \frac{\mathbf x_{n}}{y}$`.
+
 ### Diagrams
 
 Academic supports a Markdown extension for diagrams. You can enable this feature by toggling the `diagram` option in your `config/_default/params.toml` file or by adding `diagram: true` to your page front matter.
@@ -134,10 +136,18 @@ gantt
   another task      : 24d
 ```
 
-### Task lists
+### Todo lists
 
 You can even write your todo lists in Academic too:
 
+```markdown
+- [x] Write math example
+- [x] Write diagram example
+- [ ] Do something else
+```
+
+renders as
+
 - [x] Write math example
 - [x] Write diagram example
 - [ ] Do something else