https://github.com/morelinq/www

🚧
https://github.com/morelinq/www

Last synced: about 1 month ago
JSON representation

🚧

• Host: GitHub
• URL: https://github.com/morelinq/www
• Owner: morelinq
• Created: 2019-03-12T07:10:46.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-13T22:37:24.000Z (almost 6 years ago)
• Last Synced: 2024-10-29T21:05:25.143Z (about 2 months ago)
• Language: HTML
• Size: 7.41 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MoreLINQ Documentation

This is this repository for [MoreLINQ] documentation.

Documentation is written in Markdown format and built using [MkDocs] and

[MarkdownSnippets].

## Building

The following software is required for building:

- [.NET] Core SDK 2.2 or later

- Docker

Other required tools can be installed by running `install.cmd` on Windows or

`install.sh` on Linux/macOS.

Make sure that the project root is the current working directory of your

command-line shell.

Then if on Windows, run:

    dotnet build && ^

    docker run --rm -it ^

               -v "%cd%:/docs" ^

               --entrypoint /bin/sh ^

               squidfunk/mkdocs-material -c "mkdocs build"

If on Linux or macOS, run instead:

    dotnet build && \

    docker run --rm -it \

               -v "$(pwd):/docs" \

               --entrypoint /bin/sh \

               squidfunk/mkdocs-material -c "mkdocs build"

The resulting web site can be found in the `site` directory.

### Continuous Building

When writing documentation, it is helpful to preview it locally in a browser

and refresh automatically as each document is saved. To do so, open two

command-line shell terminals and change the current working directory of both

to the project root. Then run the following in one of the terminals:

    dotnet watch build

In the second terminal and if on Windows, run:

    docker run --rm -it -v -p 8000:8000 ^

           "%cd%:/docs" squidfunk/mkdocs-material

Otherwise run the following if on Linux or macOS:

    docker run --rm -it -v -p 8000:8000 \

           "$(pwd):/docs" squidfunk/mkdocs-material

Next, open a Web browser and navigate to `http://localhost:8000/`.

Note that due to a bug in `dotnet watch`, new C# source files or Markdown

documents are not detected so after creating such a file, _[touch]_ the

`doc.proj` file or force-save in the editor. There are also known issues with

Docker containers failing to sometimes pick up on file notifications on Windows.

If that seems the case then _touching_ or force-saving the `mkdocs.yml` file

usually fixes the situation.

[MoreLINQ]: https://morelinq.github.io/

[.NET]: https://dot.net/

[MkDocs]: https://www.mkdocs.org/user-guide/deploying-your-docs/

[MarkdownSnippets]: https://github.com/SimonCropp/MarkdownSnippets

[touch]: https://en.wikipedia.org/wiki/Touch_(command)