Optimised docs build and polished docs
This commit is contained in:
parent
7badcc333b
commit
e2b2c82ff7
3
docs/.dockerignore
Normal file
3
docs/.dockerignore
Normal file
@ -0,0 +1,3 @@
|
||||
.docusaurus/
|
||||
node_modules/
|
||||
.k8s/
|
@ -15,13 +15,13 @@ What this command will do is generate a `.env` file in the current directory and
|
||||
To start creating command plugins for MycroFroge, make sure you've added the devdisciples package repository.
|
||||
This can be done by running the following command.
|
||||
|
||||
```bash
|
||||
```
|
||||
dotnet nuget add source --name devdisciples https://git.devdisciples.com/api/packages/devdisciples/nuget/index.json
|
||||
```
|
||||
|
||||
Run the following command to add the `MycroForge.PluginTemplate.Package`.
|
||||
|
||||
```bash
|
||||
```
|
||||
dotnet add package --source devdisciples --version 1.0.0 MycroForge.PluginTemplate.Package
|
||||
```
|
||||
|
||||
@ -29,14 +29,14 @@ dotnet add package --source devdisciples --version 1.0.0 MycroForge.PluginTempla
|
||||
|
||||
Generate a template plugin project by running the following command.
|
||||
|
||||
```bash
|
||||
```
|
||||
m4g plugin init My.Dotenv.Plugin
|
||||
```
|
||||
|
||||
This should generate the following folder structure.
|
||||
|
||||
```
|
||||
Env.Plugin
|
||||
My.Dotenv.Plugin
|
||||
┣ 📜HelloWorldCommand.cs
|
||||
┣ 📜HelloWorldCommandPlugin.cs
|
||||
┗ 📜My.Dotenv.Plugin.csproj
|
||||
@ -51,7 +51,7 @@ HelloWorldCommandPlugin.cs => DotenvCommandPlugin.cs
|
||||
|
||||
Modify `Name` property in `DotenvCommandPlugin.cs`.
|
||||
|
||||
```C#
|
||||
```cs
|
||||
// Before
|
||||
public class DotenvCommandPlugin : ICommandPlugin
|
||||
{
|
||||
@ -77,7 +77,7 @@ public class DotenvCommandPlugin : ICommandPlugin
|
||||
|
||||
Modify `DotenvCommand.cs`.
|
||||
|
||||
```C#
|
||||
```cs
|
||||
// Before
|
||||
public class DotenvCommand : Command, ISubCommandOf<RootCommand>
|
||||
{
|
||||
@ -152,7 +152,7 @@ public class DotenvCommand : Command, ISubCommandOf<RootCommand>
|
||||
Open a terminal an make sure you're in the root directory of the plugin, i.e. the `My.Dotenv.Plugin` folder.
|
||||
Run the following command to install the plugin.
|
||||
|
||||
```bash
|
||||
```
|
||||
m4g plugin install --platform <platform=linux_arm|linux_arm64|linux_x64|osx_arm64|osx_x64>
|
||||
```
|
||||
|
||||
|
@ -22,7 +22,7 @@ For Windows users, MycroForge is designed to run in a POSIX compliant environmen
|
||||
|
||||
Before installing MycroForge, add the package registry by running the following command:
|
||||
|
||||
```sh
|
||||
```
|
||||
dotnet nuget add source --name devdisciples https://git.devdisciples.com/api/packages/devdisciples/nuget/index.json
|
||||
```
|
||||
|
||||
|
@ -77,8 +77,9 @@ const config: Config = {
|
||||
copyright: `Copyright © ${new Date().getFullYear()} DevDisciples`,
|
||||
},
|
||||
prism: {
|
||||
theme: prismThemes.github,
|
||||
darkTheme: prismThemes.dracula,
|
||||
theme: prismThemes.oneLight,
|
||||
darkTheme: prismThemes.oneDark,
|
||||
additionalLanguages: ["csharp", "bash"]
|
||||
},
|
||||
} satisfies Preset.ThemeConfig,
|
||||
};
|
||||
|
Loading…
Reference in New Issue
Block a user