For instructions on how to use DocFX, visit https://dotnet.github.io/docfx/
- Install DocFX
On OSX (brew required)
brew install docfx
On Windows (chocolately required)
choco install docfx -y
- Clone Repo
If you haven't cloned Meadow.Core and Meadow.Foundation do so first and then clone docfx
as a sibling.
git clone git@github.com:WildernessLabs/Meadow.Core.git
- Launch site:
cd docfx
docfx docfx.json --serve
To make the helper scripts executable, run these commands in the terminal after cloning:
chmod +x ./build-serve-docs.sh
chmod +x ./build-docs.sh
chmod +x ./get-latest.sh
Before committing back to the repo, run ./build-docs.sh
. This will ensure you have the latest from Meadow.Core
and Meadow.Foundation
repos. Here's a breakdown of helper scripts:
./build-docs.sh
- runs./get-latest.sh
, then runsdocfx docfx.json
./build-serve-docs.sh
- runs./get-latest.sh
, then runsdocfx docfx.json --serve
./get-latest.sh
- gets latest fromMeadow.Core
andMeadow.Foundation
You can link to APIs this way, but you probably won't use it. This works only within DocFX processed content and not within the general docs content.
- MD link notation:
[IApp](xref:Meadow.IApp)
@
notation:@"Meadow.IApp"
Both will resolve at build time to the Meadow.IApp
api doc entry.
The @
notation is shorter, but the MD notation allows you to set the link title.
If it fails on Mac/Linux with some SQLitePCLRaw
nonsense, run this:
nuget install -OutputDirectory $TMPDIR SQLitePCLRaw.core -ExcludeVersion
for docfx in /usr/local/Cellar/docfx/*; do cp "$TMPDIR/SQLitePCLRaw.core/lib/net45/SQLitePCLRaw.core.dll" "$docfx/libexec"; done
Content copyright Wilderness Labs.
Electronics tutorial copyright Bryan Costanich.
All the documentation prose is released under a Creative Commons Attribution + Noncommercial + NoDerivatives (CC BY-NC-ND) license. Feel free to share verbatim in non-commercial usage and provide attribution. Commercial usage may be granted in certain use cases. If you need a more permissive license, please contact us at hello@wildernesslabs.co.
Human Readable Version of the License
All code samples and code snippets, whether they be full applications, or embedded snippets within the documentation are released under the Apache 2 license. Feel free to use and distribute the code as you see fit, under the very permissive terms of the license.