mirror of
https://github.com/velopack/velopack.git
synced 2025-10-25 15:19:22 +00:00
wip docfx
This commit is contained in:
2
docs/.gitignore
vendored
Normal file
2
docs/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
api/
|
||||
_site/
|
||||
45
docs/docfx.json
Normal file
45
docs/docfx.json
Normal file
@@ -0,0 +1,45 @@
|
||||
{
|
||||
"metadata": [
|
||||
{
|
||||
"src": [
|
||||
{
|
||||
"src": "../src/Velopack",
|
||||
"files": [
|
||||
"**/*.csproj"
|
||||
]
|
||||
}
|
||||
],
|
||||
"dest": "api"
|
||||
}
|
||||
],
|
||||
"build": {
|
||||
"content": [
|
||||
{
|
||||
"files": [
|
||||
"**/*.{md,yml}"
|
||||
],
|
||||
"exclude": [
|
||||
"_site/**"
|
||||
]
|
||||
}
|
||||
],
|
||||
"resource": [
|
||||
{
|
||||
"files": [
|
||||
"artwork/**"
|
||||
]
|
||||
}
|
||||
],
|
||||
"output": "_site",
|
||||
"template": [
|
||||
"default",
|
||||
"modern"
|
||||
],
|
||||
"globalMetadata": {
|
||||
"_appName": "Velopack",
|
||||
"_appTitle": "Velopack",
|
||||
"_enableSearch": true,
|
||||
"pdf": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
| [docs](.) |
|
||||
|:---|
|
||||
---
|
||||
_layout: landing
|
||||
---
|
||||
|
||||
# Velopack Documentation
|
||||
🚧🚧This documentation is still under construction.🚧🚧
|
||||
0
docs/pages/getting-started/csharp.md
Normal file
0
docs/pages/getting-started/csharp.md
Normal file
5
docs/pages/getting-started/samples.md
Normal file
5
docs/pages/getting-started/samples.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Velopack Examples
|
||||
|
||||
- [**AvaloniaCrossPlat**](AvaloniaCrossPlat) - uses Avalonia to provide a desktop UI, installer, and updates for Mac, Linux, and Windows.
|
||||
|
||||
- [**VeloWpfSample**](VeloWpfSample) - demonstrates how to use Velopack effectively with WPF.
|
||||
4
docs/pages/getting-started/toc.yml
Normal file
4
docs/pages/getting-started/toc.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
- name: C# / .NET
|
||||
href: csharp.md
|
||||
- name: Sample Apps
|
||||
href: samples.md
|
||||
4
docs/pages/packaging/toc.yml
Normal file
4
docs/pages/packaging/toc.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
- name: Code Signing
|
||||
href: signing.md
|
||||
- name: Boostrapping frameworks (.NET, .Net Framework, VCRedist, etc)
|
||||
href: bootstrapping.md
|
||||
34
docs/pages/toc.yml
Normal file
34
docs/pages/toc.yml
Normal file
@@ -0,0 +1,34 @@
|
||||
- name: Getting Started
|
||||
href: getting-started/toc.yml
|
||||
- name: Migrating to Velopack
|
||||
href: migrating.md
|
||||
- name: Logging / Debugging
|
||||
href: debugging.md
|
||||
- name: Command Line Reference
|
||||
href: cli.md
|
||||
- name: Packaging Releases
|
||||
href: packaging/toc.yml
|
||||
|
||||
|
||||
|
||||
# ## Using Velopack
|
||||
# - [Migrating to Velopack](migrating.md)
|
||||
# - [Logging & Debugging](debugging.md)
|
||||
# - [Command Line Reference](cli.md)
|
||||
# - Packaging Releases
|
||||
# - Overview
|
||||
# - Release Channels
|
||||
# - Installer Overview & Customisation
|
||||
# - [Code Signing](signing.md)
|
||||
# - [Boostrapping frameworks (.NET, .Net Framework, VCRedist, etc)](bootstrapping.md)
|
||||
# - Specify app RID / supported OS versions / supported architecture
|
||||
# - Distributing Releases
|
||||
# - Overview
|
||||
# - CI / CD Tips & Examples
|
||||
# - Deploying to GitHub Releases
|
||||
# - Deploying to Amazon S3 Storage (or compatible, eg. B2, Linode)
|
||||
# - Updating
|
||||
# - Overview
|
||||
# - Rolling back to a previous release
|
||||
# - [Windows Shortcuts](shortcuts.md)
|
||||
# - Customising updates (AfterInstall, BeforeUninstall, BeforeUpdate, AfterUpdate hooks)
|
||||
4
docs/toc.yml
Normal file
4
docs/toc.yml
Normal file
@@ -0,0 +1,4 @@
|
||||
- name: Docs
|
||||
href: pages/
|
||||
- name: API
|
||||
href: api/
|
||||
Reference in New Issue
Block a user