sylk-docs 0.0.3

A sylk CLI plugin for interacting with docusaurus-sylk plugin for Docusaurus

sylk-docs

This project has been generated thanks to sylk.build !

This project is using gRPC as main code generator and utilize HTTP2 + protobuf protocols for communication.

Overview

Sylk plugin for auto-generated docs with docusaurus-sylk plugin for Docusaurus.

This plugin built with Pluggy and implement sylk.builder.hookimpl hookspec to be called from sylk cli build process.

Features

This plugin provide the following features:

• Auto generated docs with Docosaurus based on sylk schema
• Beautiful documentation based on Envoy theme
• Easy sidebar navigation
• Links references within the documentation all automatically resolves to relevant docs

Usage

This plugin project is meant to be used ONLY with Sylk CLI.

1. First install Sylk CLI with the extra provided for sylk-docs dependencies:

pip install sylk[docs]

2. Create a new project

sylk new AwesomeDocs
cd AwesomeDocs

3. There you will find sylk.json file open it and enter the following configs under configs.plugins array and project.extensions array:

{
  // ... more above ...
  "configs": {
    // ... more options ...
	"plugins": [
		"sylk-docs"
	]
  },
  "project": {
    // ... more properties above ...
    "extensions": [
	  {
	    "@type": "sylk-docs/sylk.Plugin.v1.Plugin",
		"docusaurus": {
		  "sylk": {
		    "sylkJsonPaths": [
			  "./sylk/AwesomeDocs/sylk.json"
		    ],
		    "sylkDocsPath": "./sylkdocs",
		    "sidebarPath": "./sidebarsSylkdocs.js"
		  },
		  "docs": {
		    "routeBasePath": "sylkdocs",
		    "sidebarPath": "./sidebarsSylkdocs.js"
		  }
	    }
	  }
    ]
  }
}

4. Create your project schema resources Quick Guide to sylk CLI
5. When you are ready build the project resources with sylk build command, this will run the plugin as well in the build lifecycle and will instantiate / re-build the project docs

Index

Usage:

• Python

Resources:

• docs
• Plugin
• Docusaurus
• Readme

Services

docs

build [Unary]

• Input: sylk.Docusaurus.v1.PresetOptions
• Output: google.protobuf.Empty

Packages

sylk.Plugin.v1

Plugin

Plugin

:

• readme [Markdown]

• docusaurus [PresetOptions]

sylk.Docusaurus.v1

PresetOptions

PresetOptions

:

• sylk [PluginOptions]

• docs [ContentDocOptions]

PluginOptions

PluginOptions

:

• sylkJsonPaths [TYPE_STRING]

• sylkDocsPath [TYPE_STRING]

• sidebarPath [TYPE_STRING]

• routeBasePath [TYPE_STRING]

• git [TYPE_STRING]

ContentDocOptions

ContentDocOptions

:

• routeBasePath [TYPE_STRING]

• sidebarPath [TYPE_STRING]

sylk.Readme.v1

Markdown

Markdown

:

• path [TYPE_STRING]

• title [TYPE_STRING]

Usage

This project supports clients communication in the following languages:

Python

from clients.python import sylkdocs

client = sylkdocs()

# Unary call
response = stub.<Unary>(<InMessage>())
print(response)

# Server stream
responses = stub.<ServerStream>(<InMessage>())
for res in responses:
	print(res)

# Client Stream
requests = iter([<InMessage>(),<InMessage>()])
response = client.<ClientStream>(requests)
print(response)

# Bidi Stream
responses = client.<BidiStream>(requests)
for res in responses:
	print(res)

---

This project and README file has been created thanks to sylk.build