Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

[WIP/Discussion] DocFx example for Serilog org#5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
merbla wants to merge2 commits intoserilog:master
base:master
Choose a base branch
Loading
frommerbla:docfx-playground
Open
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
docs

/docfx_project/docs
/docfx_project/src/
/docfx_project/api/serilog
/docfx_project/api/serilog-aspnetcore
/docfx_project/api/serilog-sinks-console
12 changes: 12 additions & 0 deletionsMakefile
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
build-docs:
rm -rf docfx_project/src/
rm -rf docfx_project/docs/
git clone --depth 1 --branch master git@github.com:serilog/serilog.git docfx_project/src/serilog
git clone --depth 1 --branch master git@github.com:serilog/serilog-sinks-console.git docfx_project/src/serilog-sinks-console
git clone --depth 1 --branch master git@github.com:serilog/serilog-aspnetcore.git docfx_project/src/serilog-aspnetcore

docfx metadata docfx_project/docfx.json
docfx build docfx_project/docfx.json

serve-docs:
docfx docfx_project/docfx.json --serve
12 changes: 12 additions & 0 deletionsREADME.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
# Serilog Landing Page and Documentation

## Basic Workflow

1. Install [DocFx](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html).
2. Run Make command `make build-docs`. This will do the following
* Clean src
* Shallow clone of repositories (Serilog, Sinks etc.)
* Build metadata
* Build documentation, site will be published to `docs`.
4. Run `make serve-docs` to serve content at http://localhost:8080.

9 changes: 9 additions & 0 deletionsdocfx_project/.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
docs
5 changes: 5 additions & 0 deletionsdocfx_project/api/.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest
1 change: 1 addition & 0 deletionsdocfx_project/api/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# Welcome to the Serilog API Documentation
65 changes: 65 additions & 0 deletionsdocfx_project/docfx.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
{
"metadata": [
{
"src": "src/serilog/src/**.cs",
"dest": "api/serilog"
},

{
"src": "src/serilog-aspnetcore/src/**.cs",
"dest": "api/serilog-aspnetcore"
},
{
"src": "src/serilog-sinks-console/src/**.cs",
"dest": "api/serilog-sinks-console"
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"howto/**.md",
"howto/**/toc.yml",
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"docs/**"
]
}
],
"dest": "../docs",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
1 change: 1 addition & 0 deletionsdocfx_project/howto/intro.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# Add your introductions here!
2 changes: 2 additions & 0 deletionsdocfx_project/howto/toc.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
- name: Introduction
href: intro.md
4 changes: 4 additions & 0 deletionsdocfx_project/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
# This is the **HOMEPAGE**.
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
## Quick Start Notes:
1. Add images to the *images* folder if the file is referencing an image.
5 changes: 5 additions & 0 deletionsdocfx_project/toc.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
- name: How To
href: howto/
- name: Api Documentation
href: api/
homepage: api/index.md
[8]ページ先頭
©2009-2025 Movatter.jp