Class DocusaurusProject

java.lang.Object

net.thevpc.commons.md.docusaurus.DocusaurusProject

public class DocusaurusProject
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOCUSAURUS_FOLDER_CONFIG
static final String	DOCUSAURUS_FOLDER_CONFIG_MIMETYPE

Constructor Summary

Constructors

Constructor	Description
DocusaurusProject(String docusaurusBaseFolder)

Method Summary

Modifier and Type	Method	Description
DocusaurusFileOrFolder	extractFileOrFolder(Path path, Path root)
LJSON	getConfig()
String	getDocusaurusBaseFolder()
DocusaurusFolder	getPhysicalDocsFolder()
String	getProjectName()
LJSON	getSidebars()
DocusaurusFolder	getSidebarsDocsFolder()
String	getTitle()
DocusaurusFileOrFolder[]	LJSON_to_DocusaurusFileOrFolder_list(LJSON a, String path, DocusaurusFolder root)
LJSON	loadModuleExportsFile(String path)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DOCUSAURUS_FOLDER_CONFIG

public static final String DOCUSAURUS_FOLDER_CONFIG

See Also:

• Constant Field Values

DOCUSAURUS_FOLDER_CONFIG_MIMETYPE

public static final String DOCUSAURUS_FOLDER_CONFIG_MIMETYPE

See Also:

• Constant Field Values

Constructor Details

DocusaurusProject

public DocusaurusProject(String docusaurusBaseFolder)

Method Details

getDocusaurusBaseFolder

public String getDocusaurusBaseFolder()

getSidebars

public LJSON getSidebars()

getTitle

public String getTitle()

getProjectName

public String getProjectName()

getConfig

public LJSON getConfig()

loadModuleExportsFile

public LJSON loadModuleExportsFile(String path)

extractFileOrFolder

public DocusaurusFileOrFolder extractFileOrFolder(Path path,
 Path root)

LJSON_to_DocusaurusFileOrFolder_list

public DocusaurusFileOrFolder[] LJSON_to_DocusaurusFileOrFolder_list(LJSON a,
 String path,
 DocusaurusFolder root)

getSidebarsDocsFolder

public DocusaurusFolder getSidebarsDocsFolder()

getPhysicalDocsFolder

public DocusaurusFolder getPhysicalDocsFolder()