Merge pull request #29 from elmish/feature/nacara

Feature/nacara

.editorconfig

@@ -10,3 +10,6 @@ charset = utf-8
 trim_trailing_whitespace = true
 indent_style = space
 indent_size = 2
+
+[*.{scss,json,md}]
+indent_size = 4

.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: Publish
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+      - name: Install and use custom npm version
+        run: npm i -g npm@7
+      - name: Setup workspace
+        run: npm install
+      - name: Build site
+        run: npm run docs:build
+      - name: Deploy site
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          personal_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs_deploy

.gitignore

@@ -12,3 +12,6 @@ build/
 .fake
 temp
 paket-files
+
+.nacara
+docs_deploy

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

README.md

@@ -1,8 +1,8 @@
-## Build and running the app
+## Development
 
-1. Install npm dependencies: `yarn install`
-2. Install dotnet dependencies: `dotnet restore`
-3. Start Fable server and Webpack dev server: `dotnet fable npm-run start`
-4. In your browser, open: [http://localhost:8080/](http://localhost:8080/)
+This repository use NPM scripts to control the build system here is a list of the main scripts available:
 
-Any modification you do to the F# code will be reflected in the web page after saving.
+| Script | Description |
+|---|---|
+| `npm run docs:watch` | To use when working on the documentation, hosted on [http://localhost:8080](http://localhost:8080) |
+| `npm run docs:publish` | Build a new version of the documentation and publish it to Github Pages |

babel.config.json

@@ -0,0 +1,5 @@
+{
+    "presets": [
+        "@babel/preset-react"
+    ]
+}

docs/_partials/footer.jsx

@@ -0,0 +1,119 @@
+import React from 'react';
+
+const SitemapSection = ({ title, children }) => (
+    <div className="sitemap-section">
+        <div className="sitemap-section-title">
+            {title}
+        </div>
+        <ul className="sitemap-section-list">
+            {children}
+        </ul>
+    </div>
+)
+
+const SitemapSectionItem = ({ text, icon, url }) => (
+    <li>
+        <a href={url} className="icon-text sitemap-section-list-item">
+            <span className="icon">
+                <i className={icon}></i>
+            </span>
+            <span className="sitemap-section-list-item-text">
+                {text}
+            </span>
+        </a>
+    </li>
+)
+
+const CopyrightScript = () => (
+    <script dangerouslySetInnerHTML={{
+        __html: `
+        const year = new Date().getFullYear();
+        document.getElementById('copyright-end-year').innerHTML = year;
+        `
+    }} />
+)
+
+export default (
+    <div className="is-size-5">
+        <div className="sitemap">
+            <SitemapSection title="Project ressources">
+                <SitemapSectionItem
+                    text="Repository"
+                    icon="fas fa-file-code"
+                    url="https://github.com/elmish/urlParser" />
+
+                <SitemapSectionItem
+                    text="Release notes"
+                    icon="fas fa-list"
+                    url="/urlParser/release_notes.html" />
+
+                <SitemapSectionItem
+                    text="License"
+                    icon="fas fa-id-card"
+                    url="https://github.com/elmish/urlParser/blob/master/LICENSE.md" />
+            </SitemapSection>
+
+            <SitemapSection title="Elmish modules">
+                <SitemapSectionItem
+                    text="Fable.Elmish"
+                    icon="fa fa-book"
+                    url="https://elmish.github.io/elmish/" />
+
+                <SitemapSectionItem
+                    text="Fable.Elmish.Browser"
+                    icon="fa fa-book"
+                    url="https://elmish.github.io/browser/" />
+
+                <SitemapSectionItem
+                    text="Fable.Elmish.UrlParser"
+                    icon="fa fa-book"
+                    url="https://elmish.github.io/urlParser/" />
+
+                <SitemapSectionItem
+                    text="Fable.Elmish.Debugger"
+                    icon="fa fa-book"
+                    url="https://elmish.github.io/debugger/" />
+
+                <SitemapSectionItem
+                    text="Fable.Elmish.React"
+                    icon="fa fa-book"
+                    url="https://elmish.github.io/react/" />
+
+                <SitemapSectionItem
+                    text="Fable.Elmish.HMR"
+                    icon="fa fa-book"
+                    url="https://elmish.github.io/hmr/" />
+            </SitemapSection>
+
+            <SitemapSection title="Other Links">
+                <SitemapSectionItem
+                    text="Fable"
+                    icon="faf faf-fable"
+                    url="https://fable.io" />
+
+                <SitemapSectionItem
+                    text="Fable Gitter"
+                    icon="fab fa-gitter"
+                    url="https://gitter.im/fable-compiler/Fable" />
+
+                <SitemapSectionItem
+                    text="F# Slack"
+                    icon="fab fa-slack"
+                    url="https://fsharp.org/guides/slack/" />
+
+                <SitemapSectionItem
+                    text="F# Software Foundation"
+                    icon="faf faf-fsharp-org"
+                    url="https://fsharp.org/" />
+            </SitemapSection>
+
+        </div>
+        <p className="has-text-centered">
+            Built with <a className="is-underlined" href="https://mangelmaxime.github.io/Nacara/">Nacara</a>
+        </p>
+        <p className="has-text-centered mt-2">
+            Copyright © 2021-<span id="copyright-end-year"/> Elmish contributors.
+        </p>
+        <CopyrightScript />
+    </div>
+)