diff --git a/.gitignore b/.gitignore index 796b75cf..14938f0f 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,4 @@ node_modules/ tmp/ *.log .DS_Store -docs/static/css -docs/static/js *.tgz diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..2d85f674 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,5 @@ +node_modules/ +public/ +resources/ +static/ +.hugo_build.lock diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 00000000..b794fb2f --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,17 @@ +FROM golang:1.19-alpine AS build + +RUN go install github.com/gohugoio/hugo@v0.110.0 + +# --- + +FROM alpine:3.16 + +COPY --from=build /go/bin/hugo /usr/bin/hugo + +VOLUME /site +WORKDIR /site + +EXPOSE 1313 + +ENTRYPOINT ["hugo"] +CMD [] diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..de266796 --- /dev/null +++ b/docs/README.md @@ -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). diff --git a/docs/archetypes/default.md b/docs/archetypes/default.md new file mode 100644 index 00000000..ac36e062 --- /dev/null +++ b/docs/archetypes/default.md @@ -0,0 +1,2 @@ ++++ ++++ diff --git a/docs/config.toml b/docs/config.toml new file mode 100644 index 00000000..1514d5bf --- /dev/null +++ b/docs/config.toml @@ -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 diff --git a/docs/content/en/_index.md b/docs/content/en/_index.md new file mode 100644 index 00000000..ebe05449 --- /dev/null +++ b/docs/content/en/_index.md @@ -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 >}} diff --git a/docs/content/en/docs/Getting Started/_index.md b/docs/content/en/docs/Getting Started/_index.md new file mode 100644 index 00000000..2df5aaa2 --- /dev/null +++ b/docs/content/en/docs/Getting Started/_index.md @@ -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 diff --git a/docs/content/en/docs/Library/Accessibility/_index.md b/docs/content/en/docs/Library/Accessibility/_index.md new file mode 100644 index 00000000..534203a4 --- /dev/null +++ b/docs/content/en/docs/Library/Accessibility/_index.md @@ -0,0 +1,7 @@ +--- +title: "Accessibility" +linkTitle: "Accessibility" +weight: 4 +--- + +# Accessibility diff --git a/docs/content/en/docs/Library/Components/_index.md b/docs/content/en/docs/Library/Components/_index.md new file mode 100644 index 00000000..0b6ccf3b --- /dev/null +++ b/docs/content/en/docs/Library/Components/_index.md @@ -0,0 +1,7 @@ +--- +title: "Components" +linkTitle: "Components" +weight: 2 +--- + +# Components diff --git a/docs/content/en/docs/Library/Components/accordion.md b/docs/content/en/docs/Library/Components/accordion.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Components/filters.md b/docs/content/en/docs/Library/Components/filters.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Components/forms.md b/docs/content/en/docs/Library/Components/forms.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Components/navbar.md b/docs/content/en/docs/Library/Components/navbar.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Components/notification.md b/docs/content/en/docs/Library/Components/notification.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Components/pagination.md b/docs/content/en/docs/Library/Components/pagination.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Components/sidebar.md b/docs/content/en/docs/Library/Components/sidebar.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Components/tables.md b/docs/content/en/docs/Library/Components/tables.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Customize/_index.md b/docs/content/en/docs/Library/Customize/_index.md new file mode 100644 index 00000000..a30987b8 --- /dev/null +++ b/docs/content/en/docs/Library/Customize/_index.md @@ -0,0 +1,7 @@ +--- +title: "Customize" +linkTitle: "Customize" +weight: 5 +--- + +# Customize diff --git a/docs/content/en/docs/Library/Customize/colours.md b/docs/content/en/docs/Library/Customize/colours.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Customize/typography.md b/docs/content/en/docs/Library/Customize/typography.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Elements/_index.md b/docs/content/en/docs/Library/Elements/_index.md new file mode 100644 index 00000000..612b811b --- /dev/null +++ b/docs/content/en/docs/Library/Elements/_index.md @@ -0,0 +1,7 @@ +--- +title: "Elements" +linkTitle: "Elements" +weight: 1 +--- + +# Elements diff --git a/docs/content/en/docs/Library/Elements/buttons.md b/docs/content/en/docs/Library/Elements/buttons.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Elements/icon.md b/docs/content/en/docs/Library/Elements/icon.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Elements/image.md b/docs/content/en/docs/Library/Elements/image.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Elements/paragraph.md b/docs/content/en/docs/Library/Elements/paragraph.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Elements/tag.md b/docs/content/en/docs/Library/Elements/tag.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Elements/title.md b/docs/content/en/docs/Library/Elements/title.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Helpers/_index.md b/docs/content/en/docs/Library/Helpers/_index.md new file mode 100644 index 00000000..2a7e0ff9 --- /dev/null +++ b/docs/content/en/docs/Library/Helpers/_index.md @@ -0,0 +1,7 @@ +--- +title: "Helpers" +linkTitle: "Helpers" +weight: 6 +--- + +# Helpers diff --git a/docs/content/en/docs/Library/Layout/_index.md b/docs/content/en/docs/Library/Layout/_index.md new file mode 100644 index 00000000..8733818f --- /dev/null +++ b/docs/content/en/docs/Library/Layout/_index.md @@ -0,0 +1,7 @@ +--- +title: "Layout" +linkTitle: "Layout" +weight: 3 +--- + +# Elements diff --git a/docs/content/en/docs/Library/Layout/footer.md b/docs/content/en/docs/Library/Layout/footer.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Layout/header.md b/docs/content/en/docs/Library/Layout/header.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/Layout/main.md b/docs/content/en/docs/Library/Layout/main.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/en/docs/Library/_index.md b/docs/content/en/docs/Library/_index.md new file mode 100644 index 00000000..60401986 --- /dev/null +++ b/docs/content/en/docs/Library/_index.md @@ -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 diff --git a/docs/content/en/docs/Overview/_index.md b/docs/content/en/docs/Overview/_index.md new file mode 100644 index 00000000..5168f666 --- /dev/null +++ b/docs/content/en/docs/Overview/_index.md @@ -0,0 +1,9 @@ +--- +title: "Overview" +linkTitle: "Overview" +weight: 1 +description: > + Lorem ipsum dolor sit amet +--- + +# Overview diff --git a/docs/content/en/docs/_index.md b/docs/content/en/docs/_index.md new file mode 100644 index 00000000..36ee18c7 --- /dev/null +++ b/docs/content/en/docs/_index.md @@ -0,0 +1,7 @@ +--- +title: "Documentation" +linkTitle: "Documentation" +weight: 2 +--- + +# Documentation diff --git a/docs/content/nl/_index.md b/docs/content/nl/_index.md new file mode 100644 index 00000000..28373d5e --- /dev/null +++ b/docs/content/nl/_index.md @@ -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 >}} diff --git a/docs/content/nl/docs/Aan de slag/_index.md b/docs/content/nl/docs/Aan de slag/_index.md new file mode 100644 index 00000000..29bf3b2b --- /dev/null +++ b/docs/content/nl/docs/Aan de slag/_index.md @@ -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 diff --git a/docs/content/nl/docs/Bibliotheek/Componenten/_index.md b/docs/content/nl/docs/Bibliotheek/Componenten/_index.md new file mode 100644 index 00000000..3d1f7637 --- /dev/null +++ b/docs/content/nl/docs/Bibliotheek/Componenten/_index.md @@ -0,0 +1,7 @@ +--- +title: "Componenten" +linkTitle: "Componenten" +weight: 2 +description: > + Componenten zijn ... +--- diff --git a/docs/content/nl/docs/Bibliotheek/Componenten/accordion.md b/docs/content/nl/docs/Bibliotheek/Componenten/accordion.md new file mode 100644 index 00000000..7eb69864 --- /dev/null +++ b/docs/content/nl/docs/Bibliotheek/Componenten/accordion.md @@ -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 ` +
+

Titel van de content binnen het accordeon-element

+

+ 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. +

+ +
+ +
  • + +
    +

    Titel van de content binnen het accordeon-element

    +

    + 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. +

    + +
    +
    • + + +#### HTML voorbeeld + +```html + +``` + diff --git a/docs/content/nl/docs/Bibliotheek/Componenten/filters.md b/docs/content/nl/docs/Bibliotheek/Componenten/filters.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/content/nl/docs/Bibliotheek/Componenten/forms/_index.md b/docs/content/nl/docs/Bibliotheek/Componenten/forms/_index.md new file mode 100644 index 00000000..e82ef83b --- /dev/null +++ b/docs/content/nl/docs/Bibliotheek/Componenten/forms/_index.md @@ -0,0 +1,7 @@ +--- +title: "Formulieren" +linkTitle: "Formulieren" +weight: 2 +description: > + Formulieren ... +--- diff --git a/docs/content/nl/docs/Bibliotheek/Componenten/forms/checkbox.md b/docs/content/nl/docs/Bibliotheek/Componenten/forms/checkbox.md new file mode 100644 index 00000000..233e8f64 --- /dev/null +++ b/docs/content/nl/docs/Bibliotheek/Componenten/forms/checkbox.md @@ -0,0 +1,7 @@ +--- +title: "Selectievak" +linkTitle: "Selectievak" +weight: 6 +description: > + Selectievak +--- diff --git a/docs/content/nl/docs/Bibliotheek/Componenten/forms/colour_picker.md b/docs/content/nl/docs/Bibliotheek/Componenten/forms/colour_picker.md new file mode 100644 index 00000000..93906763 --- /dev/null +++ b/docs/content/nl/docs/Bibliotheek/Componenten/forms/colour_picker.md @@ -0,0 +1,7 @@ +--- +title: "Kleurenselector" +linkTitle: "Kleurenselector" +weight: 11 +description: > + Kleurenselector +--- diff --git a/docs/content/nl/docs/Bibliotheek/Componenten/forms/email.md b/docs/content/nl/docs/Bibliotheek/Componenten/forms/email.md new file mode 100644 index 00000000..c0a2513c --- /dev/null +++ b/docs/content/nl/docs/Bibliotheek/Componenten/forms/email.md @@ -0,0 +1,7 @@ +--- +title: "Email" +linkTitle: "Email" +weight: 3 +description: > + Email +--- diff --git a/docs/content/nl/docs/Bibliotheek/Componenten/forms/fieldset.md b/docs/content/nl/docs/Bibliotheek/Componenten/forms/fieldset.md new file mode 100644 index 00000000..2e2c0523 --- /dev/null +++ b/docs/content/nl/docs/Bibliotheek/Componenten/forms/fieldset.md @@ -0,0 +1,63 @@ +--- +title: "Fieldset" +linkTitle: "Fieldset" +weight: 1 +description: > + Fieldset +--- + +# Fieldset + +## Benodige stappen + +1. Voeg de benodigde bestanden toe aan het project: + +* `form/form-base.scss` +* `form/form-textarea.scss` + +2. Voeg eventuele optionele bestanden toe: + +* `form/form-base-variables.scss` +* `form/form-textarea-variable.scss` + +## Aandachtspunten + +* Zorg ervoor dat het Fieldset een duidelijke vraag en/of duidelijk doel heeft. + Voeg een omschrijvend `