Skip to content

Commit

Permalink
release: add v4.4.0-dev notes
Browse files Browse the repository at this point in the history
  • Loading branch information
gcushen committed May 27, 2019
1 parent 2e31349 commit 4acaf84
Show file tree
Hide file tree
Showing 3 changed files with 110 additions and 2 deletions.
31 changes: 30 additions & 1 deletion content/docs/writing-markdown-latex.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ type = "docs" # Do not modify.
weight = 70

math = true
diagram = true

linktitle = "Writing content"
[menu.docs]
Expand Down Expand Up @@ -182,7 +183,35 @@ To embed **Google Documents** (e.g. slide deck), click *File > Publish to web >

## Diagrams

Diagrams can be created in the open source [draw.io](draw.io) editor. The editor has support for almost any type of diagram, from simple to complex. A diagram can be easily embedded in Academic by choosing **File > Embed > SVG** in the [draw.io](draw.io) editor and pasting the generated code into your page.
You can generate diagrams and flowcharts from text, in a similar manner as Markdown.

Just add `diagram: true` to a page's YAML front matter and insert your [Mermaid diagram syntax](https://mermaidjs.github.io) in the *Diagram* shortcode and that's it. For example,

```plaintext
{{</* diagram */>}}
graph LR;
A[Hard edge] -->|Label| B(Round edge)
B --> C{Decision}
C -->|One| D[Result one]
C -->|Two| E[Result two]
{{</* /diagram */>}}
```

renders as

{{< diagram >}}
graph LR;
A[Hard edge] -->|Label| B(Round edge)
B --> C{Decision}
C -->|One| D[Result one]
C -->|Two| E[Result two]
{{< /diagram >}}

**Academic v4.4.0-dev or greater is required to use the _Diagram_ shortcode.**

### Advanced diagrams

More advanced diagrams can be created in the open source [draw.io](draw.io) editor. The editor has support for almost any type of diagram, from simple to complex. A diagram can be easily embedded in Academic by choosing **File > Embed > SVG** in the [draw.io](draw.io) editor and pasting the generated code into your page.

Alternatively, a diagram can be exported as an [image](#images) from any drawing software, or a [document/slide](#embed-documents) containing a diagram can be embedded.

Expand Down
79 changes: 79 additions & 0 deletions content/updates/v4.4.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
+++
title = "Version 4.4 (WIP)"

date = 2019-05-27T00:00:00
toc = true # Show table of contents? true/false

diagram = true

linktitle = "Version 4.4 (WIP)"
[menu.updates]
weight = 5
+++

Release Notes tell you what's new in Academic. As always, we welcome your [feedback](https://github.com/gcushen/hugo-academic/issues). You can also [file a bug report](https://github.com/gcushen/hugo-academic/issues). *Want to update to this version?* Refer to the [update guide]({{< relref "/docs/update.md" >}}) in conjunction with the parameter changes mentioned in the [Breaking Changes](#breaking-changes) section below.

{{% alert warning %}}
This version is currently **in development**! It corresponds to the [latest *master* branch on GitHub](https://github.com/gcushen/hugo-academic). Check back here for the final notes once it is released.
{{% /alert %}}

## See what's new in Academic!

Welcome to the v4.4 release of Academic. There are a number of exciting updates in this version that we hope you will like, including:

- [**Generate diagrams and flowcharts from text**]({{< relref "writing-markdown-latex.md#diagrams" >}}), in a similar manner as Markdown
- See *Diagrams* section below
- New **Strawberry theme**
- Add support for page bundles using the *docs* layout
- Enables placing course/documentation files within their own folder, e.g. `courses/example/intro.md` can be renamed to `courses/example/intro/index.md` if desired

### Diagrams

You can generate diagrams and flowcharts from text, in a similar manner as Markdown.

Just add `diagram: true` to a page's YAML front matter and insert your [Mermaid diagram syntax](https://mermaidjs.github.io) in the *Diagram* shortcode and that's it. For example,

```plaintext
{{</* diagram */>}}
graph LR;
A[Hard edge] -->|Label| B(Round edge)
B --> C{Decision}
C -->|One| D[Result one]
C -->|Two| E[Result two]
{{</* /diagram */>}}
```

renders as

{{< diagram >}}
graph LR;
A[Hard edge] -->|Label| B(Round edge)
B --> C{Decision}
C -->|One| D[Result one]
C -->|Two| E[Result two]
{{< /diagram >}}

### Strawberry theme

{{< figure src="https://raw.githubusercontent.com/gcushen/hugo-academic/master/images/theme-strawberry.png" title="New Strawberry theme." >}}

## Breaking changes

Here are some considerations to make when updating Academic from the previous version, v4.3:

- N/A

## Misc

- convert archetypes from TOML to YAML

## Languages

- Add Romanian
- Update German

## Thank you

Last but certainly not least, a big **_Thank You_** to [all the folks](https://github.com/gcushen/hugo-academic/graphs/contributors) that helped to make Academic even better.

**Has Academic helped you?** [Please consider supporting Academic.]({{< relref "/#support" >}})
2 changes: 1 addition & 1 deletion themes/academic

0 comments on commit 4acaf84

Please sign in to comment.