Skip to content

Commit ba1f040

Browse files
authored
build: 🔧 make guidebook as a book in _quarto.yml (#20)
1 parent aee3139 commit ba1f040

File tree

2 files changed

+27
-48
lines changed

2 files changed

+27
-48
lines changed

_quarto.yml

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,38 @@
11
project:
2-
type: seedcase-theme
2+
type: book
3+
# pre-render: quarto render LICENSE.md --to html
34

4-
website:
5-
title: "Guidebook"
6-
site-url: "https://guidebook.seedcase-project.org/"
5+
book:
6+
title: "Guidebook to doing research software engineering in a team-setting"
7+
subtitle: "A living document for how we work in the Seedcase project"
8+
search:
9+
type: textbox
10+
author:
11+
- "Luke W. Johnston"
12+
- "Signe Kirk Brødbæk"
13+
- "Kristiane Beicher"
14+
- "Marton Vago"
15+
date: last-modified
716
repo-url: "https://github.com/seedcase-project/guidebook"
8-
navbar:
9-
pinned: true
10-
left:
11-
- text: "Welcome"
12-
href: index.qmd
17+
site-url: "https://guidebook.seedcase-project.org/"
18+
body-header: |
19+
::: {.callout-note appearance="default"}
20+
This guidebook is written following the [diátaxis](https://diataxis.fr/how-to-guides/) "how-to guide" style.
21+
And because this document reflects how we work in the Seedcase Project, it is living and constantly evolving. It won't ever be in a state of "done".
22+
:::
23+
chapters:
24+
- index.qmd
25+
page-footer:
26+
center:
27+
- text: "License: CC BY 4.0 {{< fa brands creative-commons >}} {{< fa brands creative-commons-by >}}"
28+
href: LICENSE.html
1329

1430
format:
15-
seedcase-html:
31+
seedcase-theme-html:
1632
include-before-body:
1733
- "includes/site-counter.html"
1834

1935
editor:
2036
markdown:
2137
wrap: 72
2238
canonical: true
23-
24-
execute:
25-
echo: false

index.qmd

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,6 @@
1-
---
2-
title: "Guidebook"
3-
toc: false
4-
about:
5-
id: hero-heading
6-
template: jolla
7-
image: home.svg
8-
image-title: "Image from Storyset"
9-
image-alt: Illustration of a ...
10-
image-shape: rectangle
11-
image-width: 25em
12-
---
1+
# Welcome!
132

14-
<!-- This style is to make the image fit more nicely on the screen. -->
15-
```{=html}
16-
<style>
17-
#quarto-content {
18-
padding-top: 0;
19-
}
20-
div.quarto-about-jolla {
21-
margin-top: 0%;
22-
}
23-
div.quarto-about-jolla .about-image {
24-
margin-bottom: -5%;
25-
}
26-
</style>
27-
```
28-
29-
::: {#hero-heading}
303
Guidebook is about...
31-
:::
32-
33-
::: {.callout-tip appearance="default"}
34-
These pages are structured follow the [Diataxis](https://diataxis.fr)
35-
how-to guide format.
36-
:::
374

385
## Who you are as the reader
396

@@ -45,4 +12,3 @@ think will read the documents:
4512
- **Managers or leaders**: ...
4613
- **Research or development operations personnel**: ...
4714

48-
## Image from [Storyset](https://storyset.com/). {.appendix}

0 commit comments

Comments
 (0)