From 1afcd22fab1b6dc5155fba7d803db8be655eb4f5 Mon Sep 17 00:00:00 2001 From: luoyunchong Date: Sat, 10 Apr 2021 20:27:52 +0800 Subject: [PATCH] add docfx support --- .github/workflows/docfx.yml | 37 +++++++++ docs/.gitignore | 15 ++++ docs/README.md | 14 ++++ docs/api/index.md | 2 + docs/docfx.json | 137 +++++++++++++++++++++++++++++++ docs/freesql/provider/index.md | 0 docs/freesql/repository/index.md | 2 + docs/images/logo.svg | 104 +++++++++++++++++++++++ docs/index.md | 11 +++ docs/toc.yml | 11 +++ 10 files changed, 333 insertions(+) create mode 100644 .github/workflows/docfx.yml create mode 100644 docs/.gitignore create mode 100644 docs/README.md create mode 100644 docs/api/index.md create mode 100644 docs/docfx.json create mode 100644 docs/freesql/provider/index.md create mode 100644 docs/freesql/repository/index.md create mode 100644 docs/images/logo.svg create mode 100644 docs/index.md create mode 100644 docs/toc.yml diff --git a/.github/workflows/docfx.yml b/.github/workflows/docfx.yml new file mode 100644 index 00000000..7bf08f0e --- /dev/null +++ b/.github/workflows/docfx.yml @@ -0,0 +1,37 @@ +name: .NET Core Deploy Docfx + +on: + push: + branches: [master] + pull_request: + branches: [master] + +jobs: + generate-docs: + runs-on: windows-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Setup .NET Core + uses: actions/setup-dotnet@v1 + with: + dotnet-version: 3.1.101 + - name: Install dependencies + run: dotnet restore + - name: Setup DocFX + uses: crazy-max/ghaction-chocolatey@v1 + with: + args: install docfx --version 2.56.7 + - name: DocFX Build + working-directory: docs + run: docfx docfx.json + continue-on-error: false + - name: Publish + if: github.event_name == 'push' + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/_site + cname: github.com + force_orphan: true diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..d5705ab8 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,15 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_site +/freesql/provider/*.yml +/freesql/provider/.manifest +/freesql/repository/*.yml +/freesql/repository/.manifest +/api/*.yml +/api/.manifest \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..df64eec7 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,14 @@ + +### DocFX +- https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html + + +run + +``` +docfx docfx_project\docfx.json --serve + +or + +docfx .\docfx.json --serve +``` \ No newline at end of file diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 00000000..22d15855 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,2 @@ +# FreeSql +TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 00000000..cad8bbd4 --- /dev/null +++ b/docs/docfx.json @@ -0,0 +1,137 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "FreeSql/*.csproj" + ], + "exclude": [ + "**/bin/**", + "**/obj/**" + ], + "src": "../" + } + ], + "dest": "api", + "disableGitFeatures": false, + "disableDefaultFilter": false + }, + { + "src": [ + { + "files": [ + "FreeSql.DbContext/*.csproj", + "FreeSql.Repository/*.csproj" + ], + "exclude": [ + "**/bin/**", + "**/obj/**" + ], + "src": "../" + } + ], + "dest": "freesql/repository", + "disableGitFeatures": false, + "disableDefaultFilter": false + }, + { + "src": [ + { + "files": [ + "Providers/FreeSql.Provider.MySql/*.csproj", + "Providers/FreeSql.Provider.Dameng/*.csproj", + "Providers/FreeSql.Provider.KingbaseES/*.csproj", + "Providers/FreeSql.Provider.MsAccess/*.csproj", + "Providers/FreeSql.Provider.MySqlConnector/*.csproj", + "Providers/FreeSql.Provider.Odbc/*.csproj", + "Providers/FreeSql.Provider.Oracle/*.csproj", + "Providers/FreeSql.Provider.PostgreSQL/*.csproj", + "Providers/FreeSql.Provider.ShenTong*.csproj", + "Providers/FreeSql.Provider.Sqlite/*.csproj", + "Providers/FreeSql.Provider.SqlServer/*.csproj", + "Providers/FreeSql.Provider.SqlServerForSystem/*.csproj" + ], + "exclude": [ + "**/bin/**", + "**/obj/**" + ], + "src": "../" + } + ], + "dest": "freesql/provider", + "disableGitFeatures": false, + "disableDefaultFilter": false + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml", + "api/index.md" + ] + }, + { + "files": [ + "freesql/repository/**.yml", + "freesql/repository/index.md" + ] + }, + { + "files": [ + "freesql/provider/**.yml", + "freesql/provider/index.md" + ] + }, + { + "files": [ + "articles/**.md", + "articles/**/toc.yml", + "toc.yml", + "*.md" + ] + } + ], + "resource": [ + { + "files": [ + "images/**", + "styles/**" + ] + } + ], + "overwrite": [ + { + "files": [ + "Docs/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "dest": "_site", + "globalMetadataFiles": [], + "fileMetadataFiles": [], + "template": [ + "default" + ], + "globalMetadata": { + "_appTitle": "FreeSql API Docs", + "_appLogoPath": "./images/logo.svg", + "_gitContribute": { + "repo": "https://github.com/dotnetcore/freesql", + "branch": "master" + }, + "_enableSearch": true + }, + "postProcessors": [], + "markdownEngineName": "markdig", + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": false + } +} \ No newline at end of file diff --git a/docs/freesql/provider/index.md b/docs/freesql/provider/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/freesql/repository/index.md b/docs/freesql/repository/index.md new file mode 100644 index 00000000..726a58de --- /dev/null +++ b/docs/freesql/repository/index.md @@ -0,0 +1,2 @@ +# repository +TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/docs/images/logo.svg b/docs/images/logo.svg new file mode 100644 index 00000000..0af3c572 --- /dev/null +++ b/docs/images/logo.svg @@ -0,0 +1,104 @@ + + + + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..f63cb3c6 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,11 @@ + +# FreeSql Document + +#### [http://freesql.net](http://freesql.net) + + + + .NET orm, Mysql orm, Postgresql orm, SqlServer orm, Oracle orm, Sqlite orm, Firebird orm, 达梦 orm, 人大金仓 orm, 神通 orm, MsAccess orm. + + - Github [https://github.com/dotnetcore/freesql](https://github.com/dotnetcore/freesql) + - Gitee [https://gitee.com/FreeSql/FreeSql-ORM](https://gitee.com/FreeSql/FreeSql-ORM) diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 00000000..e9b1d962 --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,11 @@ +- name: FreeSql Documentation + href: api/ + homepage: api/index.md + +- name: Repository Documentation + href: freesql/repository/ + homepage: freesql/repository/index.md + +- name: Provider Documentation + href: freesql/provider/ + homepage: freesql/provider/index.md