Documentation ¶
Index ¶
- func AddLanguage(lang string, create_template_from_base, create_empty_template bool) error
- func CreateEmptyTemplate(dir_path, lang string, plangs []string, doctype DocType) error
- func CreateTemplateFromBase(baseLang, lang string, doctype DocType) error
- func NewConfig(dir_path, base string, plangs []string, format FormatConfig, ...) error
- func SyncLanguage(lang string) error
- type Config
- type DocType
- type FormatConfig
- type MarkdownConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddLanguage ¶
Add new documentation language
func CreateEmptyTemplate ¶
Create an emty template of type `doctype` for the specified `lang` and `plangs`
func CreateTemplateFromBase ¶
Create template for the specified `lang` and `plangs` using <base>/docs<doctype> as reference
func NewConfig ¶
func NewConfig(dir_path, base string, plangs []string, format FormatConfig, create_template bool) error
Create new docsync `Config` and write it to the file
func SyncLanguage ¶
Types ¶
type Config ¶
type Config struct { // Primary documentation language Base string `yaml:"base"` // List of all documentations Langs []string `yaml:"langs"` // Programming languages, used in the project PLangs []string `yaml:"plangs"` // The documentation formatting rules Format FormatConfig `yaml:"format"` }
The main docsync configuration
type FormatConfig ¶
type FormatConfig struct { // Primary markup language for documentation MainDocType DocType `yaml:"main_dtype"` // Config for markdown Markdown MarkdownConfig `yaml:"md"` }
Formatting settings for different markup languages
func NewFormatConfig ¶
func NewFormatConfig(md MarkdownConfig) FormatConfig
Create new `FormatConfig`
type MarkdownConfig ¶
type MarkdownConfig struct{}
Configuration settings for markdown documentation
Click to show internal directories.
Click to hide internal directories.