Skip to content

Commit

Permalink
Move the documentation to Nacara + rework the design
Browse files Browse the repository at this point in the history
  • Loading branch information
MangelMaxime committed Dec 27, 2021
1 parent ffb6302 commit ff7cd8b
Show file tree
Hide file tree
Showing 56 changed files with 43,093 additions and 7,433 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,6 @@ charset = utf-8
trim_trailing_whitespace = true
indent_style = space
indent_size = 2

[*.{scss,json,md}]
indent_size = 4
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ build/
.fake
temp
paket-files

.nacara
docs_deploy
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
engine-strict=true
277 changes: 0 additions & 277 deletions .paket/Paket.Restore.targets

This file was deleted.

Binary file removed .paket/paket.exe
Binary file not shown.
6 changes: 0 additions & 6 deletions .paket/paket.exe.config

This file was deleted.

10 changes: 0 additions & 10 deletions NuGet.Config

This file was deleted.

12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 |
5 changes: 5 additions & 0 deletions babel.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"presets": [
"@babel/preset-react"
]
}
9 changes: 0 additions & 9 deletions build.cmd

This file was deleted.

89 changes: 0 additions & 89 deletions build.fsx

This file was deleted.

20 changes: 0 additions & 20 deletions build.sh

This file was deleted.

2 changes: 0 additions & 2 deletions css/prism.min.css

This file was deleted.

119 changes: 119 additions & 0 deletions docs/_partials/footer.jsx
Original file line number Diff line number Diff line change
@@ -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>
)
Loading

0 comments on commit ff7cd8b

Please sign in to comment.