mirror of
https://github.com/dcronqvist/DotTiled.git
synced 2025-02-05 08:52:50 +02:00
Add first example of docs
This commit is contained in:
parent
e6d94247c1
commit
0ceb27a4ca
9 changed files with 76 additions and 5 deletions
5
.gitignore
vendored
5
.gitignore
vendored
|
@ -3,6 +3,11 @@
|
|||
##
|
||||
## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
|
||||
|
||||
# Generated docs
|
||||
docs/_site/
|
||||
docs/api/
|
||||
docs/index.md
|
||||
|
||||
# User-specific files
|
||||
*.rsuser
|
||||
*.suo
|
||||
|
|
7
Makefile
7
Makefile
|
@ -1,6 +1,13 @@
|
|||
test:
|
||||
dotnet test src/DotTiled.sln
|
||||
|
||||
docs-serve: docs-build
|
||||
docfx docs/docfx.json --serve
|
||||
|
||||
docs-build:
|
||||
cp README.md docs/index.md
|
||||
docfx docs/docfx.json
|
||||
|
||||
BENCHMARK_SOURCES = DotTiled.Benchmark/Program.cs DotTiled.Benchmark/DotTiled.Benchmark.csproj
|
||||
BENCHMARK_OUTPUTDIR = DotTiled.Benchmark/BenchmarkDotNet.Artifacts
|
||||
.PHONY: benchmark
|
||||
|
|
|
@ -8,7 +8,6 @@ DotTiled is designed to be a lightweight and efficient library that provides a s
|
|||
|
||||
- [Alternative libraries and comparison + benchmarks](#alternative-libraries-and-comparison)
|
||||
- [Feature coverage comparison](#feature-coverage-comparison)
|
||||
- [Quickstart](#quickstart)
|
||||
- [Installing DotTiled](#installing-dottiled)
|
||||
|
||||
# Alternative libraries and comparison
|
||||
|
@ -74,9 +73,7 @@ Below is a comparison of the feature coverage of DotTiled and other similar libr
|
|||
> [!NOTE]
|
||||
> ✅ Full support. ⚠️ Partial support, see respective library for details about supported features. ❌ No support.
|
||||
|
||||
# Quickstart
|
||||
|
||||
### Installing DotTiled
|
||||
# Installing DotTiled
|
||||
|
||||
DotTiled is available as a NuGet package. You can install it by using the NuGet Package Manager UI in Visual Studio, or equivalent, or using the following command for the .NET CLI:
|
||||
|
||||
|
|
46
docs/docfx.json
Normal file
46
docs/docfx.json
Normal file
|
@ -0,0 +1,46 @@
|
|||
{
|
||||
"metadata": [
|
||||
{
|
||||
"src": [
|
||||
{
|
||||
"src": "../src",
|
||||
"files": [
|
||||
"DotTiled/DotTiled.csproj"
|
||||
]
|
||||
}
|
||||
],
|
||||
"dest": "api"
|
||||
}
|
||||
],
|
||||
"build": {
|
||||
"content": [
|
||||
{
|
||||
"files": [
|
||||
"**/*.{md,yml}"
|
||||
],
|
||||
"exclude": [
|
||||
"_site/**"
|
||||
]
|
||||
}
|
||||
],
|
||||
"resource": [
|
||||
{
|
||||
"files": [
|
||||
"images/**"
|
||||
]
|
||||
}
|
||||
],
|
||||
"output": "_site",
|
||||
"template": [
|
||||
"default",
|
||||
"modern",
|
||||
"template"
|
||||
],
|
||||
"globalMetadata": {
|
||||
"_appName": "DotTiled",
|
||||
"_appTitle": "DotTiled",
|
||||
"_enableSearch": true,
|
||||
"pdf": true
|
||||
}
|
||||
}
|
||||
}
|
1
docs/docs/loading-a-map.md
Normal file
1
docs/docs/loading-a-map.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Loading a map
|
1
docs/docs/quickstart.md
Normal file
1
docs/docs/quickstart.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Quick Start
|
6
docs/docs/toc.yml
Normal file
6
docs/docs/toc.yml
Normal file
|
@ -0,0 +1,6 @@
|
|||
- name: Introduction
|
||||
- href: ../index.md
|
||||
- href: quickstart.md
|
||||
|
||||
- name: Essentials
|
||||
- href: loading-a-map.md
|
4
docs/template/public/main.css
vendored
Normal file
4
docs/template/public/main.css
vendored
Normal file
|
@ -0,0 +1,4 @@
|
|||
body {
|
||||
--bs-link-color-rgb: 66, 184, 131 !important;
|
||||
--bs-link-hover-color-rgb: 64, 180, 128 !important;
|
||||
}
|
4
docs/toc.yml
Normal file
4
docs/toc.yml
Normal file
|
@ -0,0 +1,4 @@
|
|||
- name: Docs
|
||||
href: docs/
|
||||
- name: API
|
||||
href: api/
|
Loading…
Add table
Reference in a new issue