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

Adding manon-docs hugo theme and support #91

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,4 @@ node_modules/
tmp/
*.log
.DS_Store
docs/static/css
docs/static/js
*.tgz
5 changes: 5 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules/
public/
resources/
static/
.hugo_build.lock
17 changes: 17 additions & 0 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
FROM golang:1.19-alpine AS build

RUN go install github.com/gohugoio/[email protected]

# ---

FROM alpine:3.16

COPY --from=build /go/bin/hugo /usr/bin/hugo

VOLUME /site
WORKDIR /site

EXPOSE 1313

ENTRYPOINT ["hugo"]
CMD []
18 changes: 18 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Manon Docs

## Introduction

Uses [Hugo](https://gohugo.io/) to generate a static documentation site for
manon.


## Developing

```
$ docker build -t manon-docs .
$ docker run -it --rm -p 1313:1313 -v $(pwd):/site manon-docs server --bind=0.0.0.0 --baseURL=localhost:1313
```

### Updating the theme

The theme is located in [themes/manon](themes/manon).
2 changes: 2 additions & 0 deletions docs/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
+++
+++
37 changes: 37 additions & 0 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
baseURL = "https://minvws.github.io/nl-rdo-manon/"
title = "Manon Docs"
theme = "manon-docs"

defaultContentLanguage = "nl"
defaultContentLanguageInSubdir = true

[menu]

[[menu.main]]
name = "Docs"
url = "docs"
weight = 10

[languages]

[languages.nl]
contentDir = "content/nl"
languageName = "Nederlands"
weight = 1

[languages.en]
contentDir = "content/en"
languageName = "English"
weight = 2

[markup.goldmark]

[markup.goldmark.renderer]
unsafe = true

[markup.goldmark.parser]
autoHeadingID = true

[markup.highlight]
codeFences = false
noClasses = true
29 changes: 29 additions & 0 deletions docs/content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Manon"
linkTitle: "Manon"
---

# Manon

{{% alert type="error" title="Note" %}}
These instructions are still being worked on.
{{% /alert %}}

{{< blocks/section >}}
## A library full of components

Lorem ipsum dolor sit amet

## Quick and with a lot of freedom

Lorem ipsum dolor sit amet

## Only use what you need

Lorem ipsum dolor sit amet

## Handy helpers

Lorem ipsum dolor sit amet

{{< /blocks/section >}}
20 changes: 20 additions & 0 deletions docs/content/en/docs/Getting Started/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Getting started"
linkTitle: "Getting started"
weight: 2
description: >
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.
---

# Getting Started {#test}

## Level 2

### Level 3

# Level 1

## Level 2

## Level 2
7 changes: 7 additions & 0 deletions docs/content/en/docs/Library/Accessibility/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Accessibility"
linkTitle: "Accessibility"
weight: 4
---

# Accessibility
7 changes: 7 additions & 0 deletions docs/content/en/docs/Library/Components/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Components"
linkTitle: "Components"
weight: 2
---

# Components
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
7 changes: 7 additions & 0 deletions docs/content/en/docs/Library/Customize/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Customize"
linkTitle: "Customize"
weight: 5
---

# Customize
Empty file.
Empty file.
7 changes: 7 additions & 0 deletions docs/content/en/docs/Library/Elements/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Elements"
linkTitle: "Elements"
weight: 1
---

# Elements
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
7 changes: 7 additions & 0 deletions docs/content/en/docs/Library/Helpers/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Helpers"
linkTitle: "Helpers"
weight: 6
---

# Helpers
7 changes: 7 additions & 0 deletions docs/content/en/docs/Library/Layout/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Layout"
linkTitle: "Layout"
weight: 3
---

# Elements
Empty file.
Empty file.
Empty file.
10 changes: 10 additions & 0 deletions docs/content/en/docs/Library/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Library"
linkTitle: "Library"
weight: 3
description: >
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.
---

# Library
9 changes: 9 additions & 0 deletions docs/content/en/docs/Overview/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Overview"
linkTitle: "Overview"
weight: 1
description: >
Lorem ipsum dolor sit amet
---

# Overview
7 changes: 7 additions & 0 deletions docs/content/en/docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Documentation"
linkTitle: "Documentation"
weight: 2
---

# Documentation
17 changes: 17 additions & 0 deletions docs/content/nl/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Manon"
linkTitle: "Manon"
---

# Welkom bij Manon

Manon is een variable en instelbaar front-end framework. Een Open
Source-project ontwikkeld door het Ministerie van Volksgezondheid, Welzijn en
Sport.

{{% alert type="error" title="Let op" %}}
Aan deze instructies wordt nog gewerkt.
{{% /alert %}}

{{< blocks/section >}}
{{< /blocks/section >}}
17 changes: 17 additions & 0 deletions docs/content/nl/docs/Aan de slag/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Aan de slag"
linkTitle: "Aan de slag"
weight: 2
description: >
Wat je moet weten om te beginnen met Manon
---

# Aan de slag

## Voorbereiding

## Installatie

## Configuratie

## Gebruik
7 changes: 7 additions & 0 deletions docs/content/nl/docs/Bibliotheek/Componenten/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Componenten"
linkTitle: "Componenten"
weight: 2
description: >
Componenten zijn ...
---
120 changes: 120 additions & 0 deletions docs/content/nl/docs/Bibliotheek/Componenten/accordion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
---
title: "Accordeon"
linkTitle: "Accordeon"
weight: 1
description: >
Een accordeon biedt een verticale keuzelijst die je per onderdeel kunt
openklappen om meer informatie te tonen.
---

# Accordeon

Een accordeon biedt een verticale keuzelijst die je per onderdeel kunt
openklappen om meer informatie te tonen.

## Benodigde stappen

1. Voeg de benodigde bestanden toe aan het project.

* Voor een overzicht van de benodigde bestanden, zie: **TODO**

* Voeg het bijbehorende JavaScript-bestand toe aan het project.
Voor meer informatie, zie: **TODO**

2. Plaats een korte zichtbare tekst binnen een `<button>`. Bijvoorbeeld een
omschrijvende titel of een vraag. Deze tekst is zichtbaar als de accordeon
gesloten is. Zorg ervoor dat de gebruiker op basis van deze tekst kan
bepalen of de onderliggende informatie waardevol is.

3. Geef de `<button>` een unieke id en verwijs vanaf de `<div>` via een
`aria-labelledby` naar de id van de `<button>` ten behoeve van
toegankelijkheid.

4. Groepeer de verborgen content binnen een `<div>`.

## Aandachtspunten

* Standaard is het eerste ondereel opengeklapt. Dit kan aangepast worden
middels het `aria-expanded-attribute` van de `<button>`. Zie onderstaande
voorbeelden voor Standaard dichtgeklapt en Standaard opengeklapt.

## Voorbeeld

### `ul`

#### Visueel voorbeeld

<ul class="accordion">
<li>
<button id="example-accordion-ul-item-1">Voorbeeld-onderwerp 1</button>
<div aria-labelledby="example-accordion-ul-item-1">
<h1>Titel van de content binnen het accordeon-element</h1>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum suscipit
egestas leo, eu semper erat congue at. Nulla pellentesque nunc nisl, at
elementum ex aliquam ac. Fusce sed justo ullamcorper, eleifend nibh a, fringilla
lorem. Aliquam erat volutpat. Aenean risus sem, tempor at rhoncus in, suscipit
hendrerit arcu. Suspendisse ultricies semper sapien eget lobortis. Phasellus ut
sodales sem. Aenean quis libero gravida, fringilla odio venenatis, condimentum
lorem.
</p>
<ul>
<li>Lorem ipsum</li>
<li>Dolor sit amet</li>
<li>Consectetur adepiscing elit.</li>
</ul>
</div>
</li>
<li>
<button id="example-accordion-ul-item-2">Voorbeeld-onderwerp 2</button>
<div aria-labelledby="example-accordion-ul-item-2">
<h1>Titel van de content binnen het accordeon-element</h1>
<p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum suscipit
egestas leo, eu semper erat congue at. Nulla pellentesque nunc nisl, at
elementum ex aliquam ac. Fusce sed justo ullamcorper, eleifend nibh a, fringilla
lorem. Aliquam erat volutpat. Aenean risus sem, tempor at rhoncus in, suscipit
hendrerit arcu. Suspendisse ultricies semper sapien eget lobortis. Phasellus ut
sodales sem. Aenean quis libero gravida, fringilla odio venenatis, condimentum
lorem.
</p>
<ul>
<li>Lorem ipsum</li>
<li>Dolor sit amet</li>
<li>Consectetur adepiscing elit.</li>
</ul>
</div>
</li>
</ul>

#### HTML voorbeeld

```html
<ul class="accordion">
<li>
<button id="example-accordion-ul-item-1">Voorbeeld-onderwerp 1</button>
<div aria-labelledby="example-accordion-ul-item-1">
<h1>Titel van de content binnen het accordeon-element</h1>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum suscipit egestas leo, eu semper erat congue at. Nulla pellentesque nunc nisl, at elementum ex aliquam ac. Fusce sed justo ullamcorper, eleifend nibh a, fringilla lorem. Aliquam erat volutpat. Aenean risus sem, tempor at rhoncus in, suscipit hendrerit arcu. Suspendisse ultricies semper sapien eget lobortis. Phasellus ut sodales sem. Aenean quis libero gravida, fringilla odio venenatis, condimentum lorem.</p>
<ul>
<li>Lorem ipsum</li>
<li>Dolor sit amet</li>
<li>Consectetur adepiscing elit.</li>
</ul>
</div>
</li>
<li>
<button id="example-accordion-ul-item-2">Voorbeeld-onderwerp 2</button>
<div aria-labelledby="example-accordion-ul-item-2">
<h1>Titel van de content binnen het accordeon-element</h1>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum suscipit egestas leo, eu semper erat congue at. Nulla pellentesque nunc nisl, at elementum ex aliquam ac. Fusce sed justo ullamcorper, eleifend nibh a, fringilla lorem. Aliquam erat volutpat. Aenean risus sem, tempor at rhoncus in, suscipit hendrerit arcu. Suspendisse ultricies semper sapien eget lobortis. Phasellus ut sodales sem. Aenean quis libero gravida, fringilla odio venenatis, condimentum lorem.</p>
<ul>
<li>Lorem ipsum</li>
<li>Dolor sit amet</li>
<li>Consectetur adepiscing elit.</li>
</ul>
</div>
</li>
</ul>
```

Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Formulieren"
linkTitle: "Formulieren"
weight: 2
description: >
Formulieren ...
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Selectievak"
linkTitle: "Selectievak"
weight: 6
description: >
Selectievak
---
Loading