net.thevpc.nuts.toolbox.docusaurus

Class DocusaurusProject

java.lang.Object

net.thevpc.nuts.toolbox.docusaurus.DocusaurusProject

public class DocusaurusProject
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DocusaurusProject(String docusaurusBaseFolder, String docusaurusConfigBaseFolder, net.thevpc.nuts.NutsSession session)

Method Summary

Modifier and Type	Method and Description
Path	detectFile(DocusaurusFileOrFolder f)
Path	detectFileParent(DocusaurusFileOrFolder[] f)
net.thevpc.nuts.NutsObjectElement	getConfig()
String	getDocusaurusBaseFolder()
DocusaurusFolder	getPhysicalDocsFolder()
Path	getPhysicalDocsFolderBasePath()
Path	getPhysicalDocsFolderConfigPath()
String	getProjectName()
net.thevpc.nuts.NutsSession	getSession()
net.thevpc.nuts.NutsObjectElement	getSidebars()
DocusaurusFolder	getSidebarsDocsFolder()
String	getTitle()
DocusaurusFileOrFolder[]	LJSON_to_DocusaurusFileOrFolder_list(net.thevpc.nuts.NutsElement a, DocusaurusFolder root)
net.thevpc.nuts.NutsElement	loadModuleExportsFile(String path)
net.thevpc.nuts.lib.md.MdElement	resolveFolderContent(Path path)

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

DocusaurusProject

public DocusaurusProject(String docusaurusBaseFolder,
                         String docusaurusConfigBaseFolder,
                         net.thevpc.nuts.NutsSession session)

Method Detail

getSession

public net.thevpc.nuts.NutsSession getSession()

getDocusaurusBaseFolder

public String getDocusaurusBaseFolder()

getSidebars

public net.thevpc.nuts.NutsObjectElement getSidebars()

getTitle

public String getTitle()

getProjectName

public String getProjectName()

getConfig

public net.thevpc.nuts.NutsObjectElement getConfig()

loadModuleExportsFile

public net.thevpc.nuts.NutsElement loadModuleExportsFile(String path)

LJSON_to_DocusaurusFileOrFolder_list

public DocusaurusFileOrFolder[] LJSON_to_DocusaurusFileOrFolder_list(net.thevpc.nuts.NutsElement a,
                                                                     DocusaurusFolder root)

detectFileParent

public Path detectFileParent(DocusaurusFileOrFolder[] f)

detectFile

public Path detectFile(DocusaurusFileOrFolder f)

getSidebarsDocsFolder

public DocusaurusFolder getSidebarsDocsFolder()

resolveFolderContent

public net.thevpc.nuts.lib.md.MdElement resolveFolderContent(Path path)

getPhysicalDocsFolderBasePath

public Path getPhysicalDocsFolderBasePath()

getPhysicalDocsFolderConfigPath

public Path getPhysicalDocsFolderConfigPath()

getPhysicalDocsFolder

public DocusaurusFolder getPhysicalDocsFolder()