Remove documentation

This commit is contained in:
Patrik Svensson
2025-12-24 20:17:42 +01:00
parent 1002fe9feb
commit fed1b8db89
10 changed files with 10 additions and 88 deletions

View File

@@ -9,12 +9,10 @@
"npm": { "npm": {
"ignorePaths": [ "ignorePaths": [
"**/node_modules/**", "**/node_modules/**",
"**/bower_components/**", "**/bower_components/**"
"docs/**"
] ]
}, },
"ignorePaths": [ "ignorePaths": [
"resources/scripts/**", "resources/scripts/**"
"docs/**"
] ]
} }

View File

@@ -55,44 +55,4 @@ jobs:
dotnet make publish --sign \ dotnet make publish --sign \
--nuget-key="${{secrets.NUGET_API_KEY}}" \ --nuget-key="${{secrets.NUGET_API_KEY}}" \
--keyvaultUrl="${{secrets.SIGN_KEYVAULT_URL}}" \ --keyvaultUrl="${{secrets.SIGN_KEYVAULT_URL}}" \
--keyvaultCertificate="${{secrets.SIGN_KEYVAULT_CERTIFICATE}}" --keyvaultCertificate="${{secrets.SIGN_KEYVAULT_CERTIFICATE}}"
###################################################
# DOCS
###################################################
documentation:
name: Publish Documentation
needs: [build]
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Setup .NET SDK
uses: actions/setup-dotnet@v5
- name: Setup Node.js
uses: actions/setup-node@v6
with:
node-version: '24'
- name: Cache dependencies
uses: actions/cache@v4
with:
path: ~/.npm
key: npm-${{ hashFiles('package-lock.json') }}
restore-keys: npm-
- name: Publish Documentation
shell: bash
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NETLIFY_ACCESS_TOKEN: ${{ secrets.NETLIFY_ACCESS_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
run: |
cd docs
dotnet tool restore
dotnet run --configuration Release -- deploy

View File

@@ -24,7 +24,7 @@ _[![Spectre.Console NuGet Version](https://img.shields.io/nuget/v/spectre.consol
این کتابخانه توانایی ترمینال فعلی را تشخیص داده و در صورت لزوم رنگ‌ها را کاهش می‌دهد. این کتابخانه توانایی ترمینال فعلی را تشخیص داده و در صورت لزوم رنگ‌ها را کاهش می‌دهد.
![Example](docs/input/assets/images/example.png) ![Example](resources/example.png)
<h2 id="installing">نصب</h2> <h2 id="installing">نصب</h2>

View File

@@ -29,7 +29,7 @@ Python用の素晴らしい[Rich ライブラリ](https://github.com/willmcgugan
## 例 ## 例
![Example](docs/input/assets/images/example.png) ![Example](resources/example.png)
## 使用方法 ## 使用方法
@@ -294,10 +294,6 @@ table.AddRow(new Markup("[blue]Corgi[/]"), new Panel("Waldo"));
AnsiConsole.Render(table); AnsiConsole.Render(table);
``` ```
これは次のように出力を描画します。
![Table](docs/input/assets/images/table.png)
### 罫線 ### 罫線
@@ -373,21 +369,17 @@ column.Width = 15;
AnsiConsole.WriteException(ex); AnsiConsole.WriteException(ex);
``` ```
![exception](docs/input/assets/images/exception.png)
### 例外の省略表示 ### 例外の省略表示
例外の特定部分を短くして、さらに読みやすくしたり、パスをクリック可能なハイパーリンクにすることもできます。 例外の特定部分を短くして、さらに読みやすくしたり、パスをクリック可能なハイパーリンクにすることもできます。
ハイパーリンクがクリックできるかはターミナル次第です。 ハイパーリンクがクリックできるかはターミナル次第です。
```csharp ```csharp
AnsiConsole.WriteException(ex, AnsiConsole.WriteException(ex,
ExceptionFormats.ShortenPaths | ExceptionFormats.ShortenTypes | ExceptionFormats.ShortenPaths | ExceptionFormats.ShortenTypes |
ExceptionFormats.ShortenMethods | ExceptionFormats.ShowLinks); ExceptionFormats.ShortenMethods | ExceptionFormats.ShowLinks);
``` ```
![exception](docs/input/assets/images/compact_exception.png)
### 例外出力のカスタマイズ ### 例外出力のカスタマイズ
例外の特定部分を短縮するだけでなく、デフォルトのスタイルを上書きすることもできます。 例外の特定部分を短縮するだけでなく、デフォルトのスタイルを上書きすることもできます。
@@ -409,6 +401,4 @@ AnsiConsole.WriteException(ex, new ExceptionSettings
LineNumber = Style.WithForeground(Color.Cornsilk1), LineNumber = Style.WithForeground(Color.Cornsilk1),
} }
}); });
``` ```
![exception](docs/input/assets/images/custom_exception.png)

View File

@@ -26,7 +26,7 @@ It is heavily inspired by the excellent Python library, [Rich](https://github.co
and downgrade colors as needed. and downgrade colors as needed.
* Written with unit testing in mind. * Written with unit testing in mind.
![Example](docs/input/assets/images/example.png) ![Example](これは次のように出力を描画します。/example.png)
## Important Notices ## Important Notices

View File

@@ -25,7 +25,7 @@ para Python.
A biblioteca detectará os recursos do terminal atual A biblioteca detectará os recursos do terminal atual
e reduz as cores conforme necessário. e reduz as cores conforme necessário.
![Exemplo](docs/input/assets/images/example.png) ![Exemplo](resources/example.png)
## Instalação ## Instalação

View File

@@ -21,7 +21,7 @@ _[![Spectre.Console NuGet Version](https://img.shields.io/nuget/v/spectre.consol
* 支持大部分的 SRG 参数,包括粗体、暗淡字、斜体、下划线、删除线和闪烁文本。 * 支持大部分的 SRG 参数,包括粗体、暗淡字、斜体、下划线、删除线和闪烁文本。
* 支持终端显示 3/4/8/24 位色。自动检测终端类型,自适应颜色范围。 * 支持终端显示 3/4/8/24 位色。自动检测终端类型,自适应颜色范围。
![例子](docs/input/assets/images/example.png) ![例子](resources/example.png)
## 安装 ## 安装

BIN
resources/example.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 219 KiB

View File

@@ -7,7 +7,6 @@
$Output = Join-Path $PSScriptRoot "Temp" $Output = Join-Path $PSScriptRoot "Temp"
$Generator = Join-Path $PSScriptRoot "/../../src/Generator" $Generator = Join-Path $PSScriptRoot "/../../src/Generator"
$Source = Join-Path $PSScriptRoot "/../../src/Spectre.Console" $Source = Join-Path $PSScriptRoot "/../../src/Spectre.Console"
$Docs = Join-Path $PSScriptRoot "/../../docs/src/Data"
if(!(Test-Path $Output -PathType Container)) { if(!(Test-Path $Output -PathType Container)) {
New-Item -ItemType Directory -Path $Output | Out-Null New-Item -ItemType Directory -Path $Output | Out-Null
@@ -23,5 +22,4 @@ if(!$?) {
Pop-Location Pop-Location
# Copy the files to the correct location # Copy the files to the correct location
Copy-Item (Join-Path "$Output" "Emoji.Generated.cs") -Destination "$Source/Emoji.Generated.cs" Copy-Item (Join-Path "$Output" "Emoji.Generated.cs") -Destination "$Source/Emoji.Generated.cs"
Copy-Item (Join-Path "$Output" "emojis.json") -Destination "$Docs/emojis.json"

View File

@@ -1,24 +0,0 @@
#!/usr/local/bin/pwsh
[CmdletBinding(PositionalBinding=$false)]
Param(
[Parameter(ValueFromRemainingArguments)]
[string[]]$Remaining
)
# first arg is either the name of a single sample you want to run or leave
# blank if you want to run them all. the samples aren't going to run at the same
# speed each time so if you run all of them you'll have everything as a change
# for your commit so use this sparingly.
$Generator = Join-Path $PSScriptRoot "/../../src/Generator"
$Output = Join-Path $PSScriptRoot "../../docs/input/assets/casts"
# Generate the files
Push-Location $Generator
&dotnet run -- samples -o "$Output" $Remaining
if(!$?) {
Pop-Location
Throw "An error occured when generating code."
}
Pop-Location