Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance docs #109

Merged
merged 30 commits into from
Oct 29, 2024
Merged
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
ad665bc
Capitalise Closeread in plain text
Oct 23, 2024
498d37b
Elaborate home page what's next section
Oct 23, 2024
d81955c
Elaborate Guide index page
Oct 23, 2024
1162dca
Move home page lead to subtitle
Oct 23, 2024
a0fc1ea
Add authoring tools page
Oct 23, 2024
2812d53
Align language on layout page
Oct 23, 2024
e9c6eae
Add step to myfirstcr.qmd to explain triggers and stickies
Oct 23, 2024
ba6ed41
Tweaks to Components section of guide
Oct 23, 2024
886e240
Add fenced div link to authoring tools
Oct 23, 2024
1500f1f
Add ID to remove header space section
Oct 23, 2024
91a0d4f
Shuffle focus effects to position zoom as pan + scale combo
Oct 23, 2024
69d81f5
Tweak case on authoring tools title
Oct 23, 2024
c52ddec
Add styling guide
Oct 23, 2024
c25aaef
Add links to connect guide docs
Oct 23, 2024
579494b
simplify look at the top of doc
andrewpbray Oct 24, 2024
575f3bf
add text of hello-world document into guide
andrewpbray Oct 25, 2024
1af676f
add page navigation
andrewpbray Oct 25, 2024
80fc68b
narrow the body width of the guide so its easier to read
andrewpbray Oct 25, 2024
0a1f0c0
remove linked sentences.
andrewpbray Oct 25, 2024
0638174
change title
andrewpbray Oct 25, 2024
1fdc3b7
switch to title case (a la quarto guide)
andrewpbray Oct 25, 2024
edeb2b5
fix typo
andrewpbray Oct 25, 2024
3e3de2f
move comment to layout doc
andrewpbray Oct 25, 2024
4aa666c
fix typos
andrewpbray Oct 25, 2024
f26607c
small formatting stuff
andrewpbray Oct 25, 2024
74c165d
fix typo
andrewpbray Oct 25, 2024
8bb89cc
Add YAML styling options to dcos
Oct 29, 2024
a86ef0b
Merge branch 'jimjam-slam/issue77' of github.com:qmd-lab/closeread in…
Oct 29, 2024
deea515
Make code blocks in cr-sections fully opaque
Oct 29, 2024
8082b90
Merge branch 'dev' into jimjam-slam/issue77
jimjam-slam Oct 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add text of hello-world document into guide
andrewpbray committed Oct 25, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 575f3bfe9ad7f80700ce7994f54440edcc22fe2d
41 changes: 34 additions & 7 deletions docs/guide/index.qmd
Original file line number Diff line number Diff line change
@@ -1,20 +1,47 @@
---
title: Guide
subtitle: Start with the basics of a Closeread document, then learn to master more advanced techniques.
toc: true
---

If you've never made a Closeread document, start with the very minimal example on the [home page](/), then come back here!
If you've never made a Closeread document, copy and paste the following document into a qmd document.

[Components of a Closeread document](components.qmd) teaches you the essential parts of a Closeread document: sections, stickies and triggers.
```{.markdown filename="myfirstcr.qmd"}
---
title: My First Closeread
format: closeread-html
---

Hello World! Please read my closeread story below.

:::{.cr-section}

Closeread enables scrollytelling.

Draw your readers attention with focus effects. @cr-features

:::{#cr-features}
1. Highlighting
2. Zooming
3. Panning
:::

:::

```

[Focus Effects](focus-effects.qmd) let you guide your readers to parts of your content by highlighting text and code, or zooming in on parts of an image or text. You can also ensure that content scales responsively, no matter what devices your readers use.
In the same directory as this qmd file, run the following command to make the Closeread extension available to this document.

[Layouts](layouts.qmd) teaches you how to customise the layouts of your Closeread sections - that is, where the stickies and triggers sit - as well as other useful tools that change the structure of the page.
```bash
quarto add qmd-lab/closeread
```

[Authoring tools](authoring-tools.qmd) covers other useful tools to help you generate scrollytelling content, including ways to use [Observable JavaScript](https://quarto.org/docs/computations/ojs.html) to make animated graphics with Closeread.
Now you can render the document and scroll through your first scrollytelling story. Continue the adventure by reading this Guide:

[Styling](styling.qmd) shows you how to change the appearance of your documents from the default Quarto theme.
- [Components of a Closeread Document](components.qmd) teaches you the essential parts of a Closeread document: sections, stickies and triggers.
- [Focus Effects](focus-effects.qmd) let you guide your readers to parts of your content by highlighting text and code, or zooming in on parts of an image or text. You can also ensure that content scales responsively, no matter what devices your readers use.
- [Layouts](layouts.qmd) teaches you how to customise the layouts of your Closeread sections - that is, where the stickies and triggers sit - as well as other useful tools that change the structure of the page.
- [Interactive Graphics](authoring-tools.qmd) shows you how use [Observable JavaScript](https://quarto.org/docs/computations/ojs.html) to make graphics that animate as your user scrolls.
- [Styling](styling.qmd) teaches you how to change the appearance of your documents from the default Quarto theme.

When you've finished the Guide, be sure to have a look at the [Gallery](/gallery) for more examples of what you can do with Closeread!