Skip to content

Commit

Permalink
Upgrade documentation to latest Nacara
Browse files Browse the repository at this point in the history
  • Loading branch information
MangelMaxime committed Feb 26, 2022
1 parent 844c54a commit a84fe7b
Show file tree
Hide file tree
Showing 24 changed files with 1,833 additions and 63 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -339,3 +339,5 @@ ASALocalRun/
fableBuild
examples/output/
temp/
docs_deploy/
.nacara/
Binary file removed docs/assets/what_to_use_schema.jpg
Binary file not shown.
Binary file removed docs/assets/what_to_use_schema.odp
Binary file not shown.
339 changes: 339 additions & 0 deletions docs/assets/what_to_use_schema.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions docs/changelog/Fable.Form.Simple.Bulma.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Fable.Form.Simple.Bulma
layout: changelog
extra:
changelog_path: ./../../../packages/Fable.Form.Simple.Bulma/CHANGELOG.md
changelog_path: ./../../packages/Fable.Form.Simple.Bulma/CHANGELOG.md
---
3 changes: 1 addition & 2 deletions docs/changelog/Fable.Form.Simple.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Fable.Form.Simple
layout: changelog
extra:
changelog_path: ./../../../packages/Fable.Form.Simple/CHANGELOG.md
changelog_path: ./../../packages/Fable.Form.Simple/CHANGELOG.md
---
3 changes: 1 addition & 2 deletions docs/changelog/Fable.Form.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Fable.Form
layout: changelog
extra:
changelog_path: ./../../../packages/Fable.Form/CHANGELOG.md
changelog_path: ./../../packages/Fable.Form/CHANGELOG.md
---
3 changes: 1 addition & 2 deletions docs/changelog/fable-form-simple-bulma.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: fable-form-simple-bulma
layout: changelog
extra:
changelog_path: ./../../../packages/fable-form-simple-bulma/CHANGELOG.md
changelog_path: ./../../packages/fable-form-simple-bulma/CHANGELOG.md
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
layout: standard
title: Fieldset / Groups
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
layout: standard
title: Form list
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
layout: standard
title: Installation
---

Expand Down
11 changes: 11 additions & 0 deletions docs/fable-form-simple-bulma/menu.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[
"fable-form-simple-bulma/installation",
{
"type": "section",
"label": "Components",
"items": [
"fable-form-simple-bulma/components/fieldset",
"fable-form-simple-bulma/components/form-list"
]
}
]
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
layout: standard
title: Custom view templates
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
layout: standard
title: Features
---

Expand Down
4 changes: 4 additions & 0 deletions docs/fable-form-simple/menu.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[
"fable-form-simple/features",
"fable-form-simple/customisation"
]
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
layout: standard
title: How to use ?
---

Expand Down
10 changes: 10 additions & 0 deletions docs/fable-form/menu.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[
{
"type": "section",
"label": "Getting started",
"items": [
"fable-form/how_to_use",
"fable-form/use_what_you_need"
]
}
]
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
layout: standard
title: Use what you need
---

Expand All @@ -24,10 +25,10 @@ Only `Fable.Form` is mandatory, see below how to choose what you should use depe

<span class="has-text-centered">

*[Click here to see the list of supported field by Fable.Form.Simple](/Fable.Form/Fable.Form.Simple/features.html)*
*[Click here to see the list of supported field by Fable.Form.Simple](/Fable.Form/docs/Fable.Form.Simple/features.html)*

</span>

<br />

![What to use schema](../assets/what_to_use_schema.jpg)
![What to use schema](../../assets/what_to_use_schema.svg)
16 changes: 16 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
layout: navbar-only
title: Introduction
---

<div class="container content section">
<div class="columns">
<div class="column is-8-widescreen is-offset-2-widescreen">

Fable.Form allows you to build forms that are:

- **Composable:** they can be extended and embedded into other forms
Expand Down Expand Up @@ -50,3 +55,14 @@ let form : Form.Form<Values, Msg> =
|> Form.append emailField
|> Form.append passwordField
```
<br />

<div class="is-flex is-justify-content-center">
<a href="/Fable.Form/fable-form/how_to_use.html" class="button is-primary is-medium">
Gettting Started
</a>
</div>

</div>
</div>
</div>
12 changes: 12 additions & 0 deletions docs/sponsors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: standard
title: Sponsors & Backers
---

The development of this project is made possible thanks to the support of these awesome sponsors & backers.

[Become a backer or sponsor on Patreon](https://www.patreon.com/MangelMaxime)

If you prefer one time donation, you can do it via [Paypal](https://www.paypal.me/MangelMaxime)

<object data="https://mangelmaxime.github.io/sponsors/backers.svg"></object>
87 changes: 36 additions & 51 deletions docs/style.scss
Original file line number Diff line number Diff line change
@@ -1,27 +1,58 @@
@import "./../node_modules/bulma/sass/utilities/initial-variables";

$primary: #176663;
$primary-light: lighten($primary, 8%);
$primary-dark: white;
$success: #66bd77;
$warning: #ffa17a;
$info: #6672b4;
$danger: #b3507a;

@import "./../node_modules/bulma/sass/utilities/derived-variables";

/////////////////////////////////
/// nacara-layout-standard customizations
/// Do not touch unless you know what you are doing
/////////////////////////////////
$navbar-breakpoint: 0px;
$navbar-padding-vertical: 0.5rem;
$navbar-padding-horizontal: 1rem;
/////////////////////////////////

// Specific to gatsby-remark-vscode usage
$content-pre-padding: unset;

/////////////////////////////////
/// Customize Bulma
/////////////////////////////////

$navbar-item-color: $white;
$navbar-background-color: $primary;
$navbar-item-active-color: $white;
$navbar-item-active-background-color: lighten($primary, 8%);
$navbar-item-hover-color: $white;
$navbar-item-hover-background-color: lighten($primary, 8%);
$navbar-dropdown-item-active-background-color: lighten($primary, 8%);
$navbar-dropdown-item-hover-background-color: lighten($primary, 8%);
$navbar-dropdown-item-hover-color: $white;
$navbar-dropdown-item-active-color: $white;

$menu-item-active-background-color: transparent;
$menu-item-active-color: $primary;
$menu-item-hover-color: $primary;
$menu-item-hover-background-color: transparent;

$toc-item-active-font-weight: $weight-semibold;
$menu-item-active-background-color: $primary;
$menu-item-active-color: $white;
$menu-item-hover-color: $primary;
$menu-item-hover-background-color: transparent;
$menu-label-font-size: $size-6;
$menu-item-radius: $radius-large $radius-large;

$body-size: 15px;

@import "./../node_modules/bulma/bulma.sass";
@import "./../node_modules/nacara/scss/nacara.scss";
@import "./../node_modules/nacara-layout-standard/scss/nacara.scss";

// Begin: fable-form-simple-bulma

Expand All @@ -30,59 +61,13 @@ $fieldset-shadow: unset;

// End: fable-form-simple-bulma

a:hover {
text-decoration: underline;
}
// a:hover {
// text-decoration: underline;
// }

// Doesn't underline link inside tabs element
.tabs {
a:hover {
text-decoration: none;
}
}

// Ensure minimal size of the doc content
// This allows to not have the 'Previous' & 'Next' button in the middle of the screen
// when their are not a lot of content on the page
.is-main-content > .section {
min-height: calc(
100vh - 7.5em
); // 7.5em = 3em (section margin top) - 3em (section margin bottom) - 1.5em (to not stick too low)
}

// Add a border to the menu-container making it easier to see the different section of the page
// Menu | Content | Toc
.menu-container {
.menu {
border-right: 1px solid #e0e0e0;
padding-right: 1rem;

a.is-active {
text-decoration: underline;
font-weight: $weight-bold;
}
}
}

.toc-container {
margin-top: 1.5rem;
}

ul.textual-steps > li {
font-weight: $weight-normal;
}

.full-height-scrollable-content {
scrollbar-width: thin;
scrollbar-color: $grey-light $white-ter;

&::-webkit-scrollbar {
width: 6px;
height: 8px;
background-color: $white-ter;
}

&::-webkit-scrollbar-thumb {
background: $grey-light;
}
}
108 changes: 108 additions & 0 deletions nacara.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{
"serverPort": 8081,
"siteMetadata": {
"title": "Fable.Form",
"url": "https://mangelmaxime.github.io",
"baseUrl": "/Fable.Form/",
"editUrl" : "https://github.com/MangelMaxime/Fable.Form/edit/main/docs"
},
"navbar": {
"start": [
{
"pinned": true,
"label": "Docs",
"items": [
{
"section": "fable-form",
"label": "Fable.Form",
"description": "Extensible core library used to build forms",
"url": "/Fable.Form/fable-form/how_to_use.html"
},
"divider",
{
"section": "fable-form-simple",
"label": "Fable.Form.Simple",
"description": "Simple form implementation, you can write your own view on top of it",
"url": "/Fable.Form/fable-form-simple/features.html"
},
"divider",
{
"section": "fable-form-simple-bulma",
"label": "Fable.Form.Simple.Bulma",
"description": "View implementation for Fable.Form.Simple based on Bulma",
"url": "/Fable.Form/fable-form-simple-bulma/installation.html"
}
]
},
{
"section": "examples",
"label": "Examples",
"url": "/Nacara/reference/Nacara.Core/index.html"
},
{
"section": "changelogs",
"label": "Changelogs",
"items": [
{
"label": "Nacara",
"url": "/Nacara/changelogs/nacara.html"
},
{
"label": "Nacara.Core",
"url": "/Nacara/changelogs/nacara-core.html"
},
{
"label": "Nacara.Standard.Layout",
"url": "/Nacara/changelogs/nacara-layout-standard.html"
},
{
"label": "Nacara.ApiGen",
"url": "/Nacara/changelogs/nacara-apigen.html"
}
]
},
{
"url": "https://gitter.im/fable-compiler/Fable",
"label": "Support"
},
{
"section": "sponsors",
"label": "Sponsors",
"url": "/Fable.Form/sponsors.html"
}
],
"end": [
{
"url": "https://github.com/MangelMaxime/Fable.Form",
"icon": "fab fa-github",
"label": "GitHub"
},
{
"url": "https://twitter.com/MangelMaxime",
"icon": "fab fa-twitter",
"label": "Twitter"
}
]
},
"remarkPlugins": [
{
"resolve": "gatsby-remark-vscode",
"property": "remarkPlugin",
"options": {
"theme": "Atom One Light",
"extensions": [
"vscode-theme-onelight"
]
}
},
{
"resolve": "remark-github",
"options": {
"repository": "MangelMaxime/Fable.Form"
}
}
],
"layouts": [
"nacara-layout-standard"
]
}
Loading

0 comments on commit a84fe7b

Please sign in to comment.