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 13 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).
File renamed without changes.
File renamed without changes.
208 changes: 208 additions & 0 deletions docs/_docs/components.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,208 @@
<!DOCTYPE html>
<html lang="nl">

<head>
<meta charset="UTF-8" />
<title>Componenten</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="../static/css/main.css" rel="stylesheet" />
<link href="../static/img/favicon.ico" rel="shortcut icon" />
<script defer src="../../static/js/manon.js"></script>
</head>

<body id="index">
<header>
<a href="#main-content" class="button focus-only skip-to-content">Ga direct naar inhoud</a>

<nav aria-label="Hoofdnavigatie">
<div>
<ul>
<li><a href="../index.html">Home</a></li>
<li>
<a href="./components.html" aria-current="page">Componenten</a>
</li>
<li><a href="./documentation.html">Documentatie</a></li>
</ul>
</div>
</nav>

<nav class="breadcrumb-bar">
<div>
<ul>
<li>
<a href="./components.html" aria-current="page">Componenten</a>
</li>
</ul>
</div>
</nav>
</header>

<main id="main-content" tabindex="-1">
<article>
<div>
<section id="introduction">
<h1>Componenten</h1>
<p>
Gebruik de gewenste componenten. Voeg de bijbehorende CSS bestanden en html toe aan
het project. Veel componenten zijn instelbaar qua vormgeving zodat ze aan kunnen
sluiten bij de huisstijl.
</p>
</section>

<section>
<h2>Beschikbare componenten</h2>
<div class="column-4">
<nav aria-labelledby="branding">
<h3 id="layout-heading">Basis-opmaak</h3>
<ul>
<li><a href="./components/application-base.html">Stijlkeuzes op applicatie-niveau</a>
</li>
<li><a href="./components/font.html">Lettertype</a></li>
<li><a href="./components/headings.html">Titels</a></li>
<li><a href="./components/branding-colors.html">Kleurensets</a></li>
</ul>
</nav>

<nav aria-labelledby="layout-heading">
<h3 id="layout-heading">Tekst en basisopmaak</h3>
<ul>
<li><a href="./components/font.html">Lettertype</a></li>
<li><a href="./components/headings.html">Titels</a></li>
<li><a href="./components/paragraph.html">Paragraaf</a></li>
<li>
<a href="./components/emphasized.html">Benadrukte weergave</a>
</li>
<li>
<a href="./components/de-emphasized.html">Subtielere weergave</a>
</li>
<li><a href="./components/nota-bene.html">Nota bene</a></li>
</ul>
</nav>

<nav aria-labelledby="layout-heading">
<h3 id="layout-heading">Layout</h3>
<ul>
<li><a href="./components/layouts.html">Layouts</a></li>
<li><a href="./components/tiles.html">Tegelweergave</a></li>
<li><a href="./components/footer.html">Footer</a></li>
</ul>
</nav>

<nav aria-labelledby="base-heading">
<h3 id="base-heading">Basis-componenten</h3>
<ul>
<li><a href="./components/button.html">Knoppen</a></li>
<li><a href="./components/forms.html">Formulieren</a></li>
<li><a href="./components/table.html">Tabellen</a></li>
<li>
<a href="./components/description-list.html">Description list</a>
</li>
</ul>
</nav>

<nav aria-labelledby="colors-heading">
<h3 id="colors-heading">Kleuren</h3>
<ul>
<li><a href="./components/branding-colors.html">Kleurensets</a></li>
<li><a href="./components/finn-small.html">Klein (twee kleuren)</a></li>
<li><a href="./components/finn-medium.html">Middel (drie kleuren)</a></li>
<li><a href="./components/finn-large.html">Groot (vijf kleuren)</a></li>
<li><a href="./components/spot-mini.html">Spot mini (twee hoofdkleuren en een
accentkleur)</a></li>
<li><a href="./components/spot-small.html">Spot klein (twee hoofdkleuren en twee
accentkleuren)</a></li>
<li><a href="./components/spot-medium.html">Spot middel (twee hoofdkleuren en drie
accentkleuren)</a></li>
<li><a href="./components/spot-large.html">Spot groot (twee hoofdkleuren en vijf
accentkleuren)</a></li>
</ul>
</nav>

<nav aria-labelledby="navigation-heading">
<h3 id="navigation-heading">Navigatie</h3>
<ul>
<li><a href="./components/side-menu.html">Zijmenu</a></li>
<li>
<a href="./components/login-meta.html">Ingelogd als</a>
</li>
</ul>
</nav>

<nav aria-labelledby="helper-classes-heading">
<h3 id="helper-classes-heading">Helper-classes</h3>
<ul>
<li>
<a href="./components/horizontal-view.html">Horizontaal uitgelijnd</a>
</li>
<li>
<a href="./components/layout-centered.html">Gecentreerd</a>
</li>
<li>
<a href="./components/focus-only.html">Alleen zichtbaar "on focus"</a>
</li>
<li>
<a href="./components/horizontal-scroll.html">Horizontale scroll</a>
</li>
<li>
<a href="./components/nowrap.html">nowrap</a>
</li>
<li>
<a href="./components/hidden.html">Verbergen - <dfn>hidden</dfn></a>
</li>
</ul>
</nav>

<nav aria-labelledby="accessibility-heading">
<h3 id="accessibility-heading">Toegankelijkheid</h3>
<ul>
<li>
<a href="./components/max-line-length.html">Maximale regellengte</a>
</li>
</ul>
</nav>

<nav aria-labelledby="notifications-heading">
<h3 id="notifications-heading">Notificaties</h3>
<ul>
<li>
<a href="./components/message-counter.html">Notificatie-teller</a>
</li>
<li>
<a href="./components/notifications.html">Notificaties</a>
</li>
</ul>
</nav>

<nav aria-labelledby="images-heading">
<h3 id="images-heading">Afbeeldingen</h3>
<ul>
<li><a href="./components/logo.html">Logo</a></li>
<li><a href="./components/icons.html">Iconen</a></li>
<li>
<a href="./components/image-cover.html">Cover-afbeelding</a>
</li>
<li>
<a href="./components/image-round.html">Ronde afbeelding</a>
</li>
<li>
<a href="./components/image-square.html">Vierkante afbeelding</a>
</li>
</ul>
</nav>

<nav aria-labelledby="miscellaneous-heading">
<h3 id="miscellaneous-heading">Overig</h3>
<ul>
<li><a href="./components/accordion.html">Accordeon</a></li>
<li><a href="./components/filter.html">Filter</a></li>
<li><a href="./components/tag.html">Tag</a></li>
</ul>
</nav>
</div>
</section>
</div>
</article>
</main>
</body>

</html>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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.
Loading