Package: markdownCreation
markdown-creationA markdown file creation module for Python!Table of Contentmarkdown-creationTable of ContentWhat is markdown-creation?FeaturesHow to use?MarkdownFileHeaderQuoteOrderedListListInlineCodeBlockCodeSeparatorLinkImageTableFootnoteHeadingIDDefinitionStrikethroughTaskListParagraphBoldTextItalicTextBoldAndItalicTextTableOfContentDependenciesBy the wayWhat is markdown-creation?markdown-creation is a Python Module which lets you write Markdown Files (.mdfiles likeREADME.md)Especially useful when it comes down to creating your documentations programmatically (writing scripts to automate things) or rendering files for web servers, it can do many things!FeaturesMarkdown File CreationAutomatic Table of Content creationTable creationHTML output (normal or minified)Less syntax errorsEasy to useHow to use?Here is a list of all the objects which comes with markdown-creationMarkdownFileThis object initializes a new markdown fileYou need to initialize a markdown file to put content in it. To initialize a new markdown file, just call it in a variablemyAwesomeFile = MarkdownFile()FunctionsDescriptionArgumentsReturned Valueadd()Adds a line to the markdown fileobject: What you want to add (it could be multiple objects but inside of an object, a string)Nothingsave()Saves the markdown file to the given locationdestination: The destination of the file; appendToExistingFile: Wether or not you want to override (False) or append (True) if the file is already existingNothingtableOfContent()Returns a string representing the table of content at the current state (yeah I can't predict what you're going to put inside your file)level: The maximum header level you want to addA string with the table of contentrender()Renders the whole file into a stringNo argumentA string with the markdown filehtml()Renders the file as an HTML file and gives back a string (and outputs it if you set the destination argument)title: Set this if you want to override the HTML title tag (by default it takes the first header content); onlyMarkdown: If you don't want a whole HTML file but only the HTML representation of your markdown file; minify: If you want to minify the HTML; destination: Set this argument if you want to output your HTML fileA string with the HTML fileThere is no arguments to pass for the MarkdownFileobject.HeaderThis object returns a markdown header (# content) and adds a header to the index of headers of the provided markdown fileCallHeader()with the needed argumentThere is no functions for the Headerobject.ArgumentDescriptiontextThe content of the headerlevelThe level of the header (how many #)markdownObjThe MarkdownFile() object you want to add the header (used to make the Table of Content)QuoteThis object returns a markdown quotation text (> content)CallQuote()with the needed argumentThere is no functions for the Quoteobject.ArgumentDescriptiontextThe content of the quotelevelThe level of the quotation (how many >)OrderedListThis object returns a markdown ordered list (contentcontent)CallOrderedList()with the needed argumentThere is no functions for the OrderedListobject.ArgumentDescriptioninputListThe list to turn into a markdown ordered listListThis object returns a markdown list (contentcontent)CallList()with the needed argumentThere is no functions for the Listobject.ArgumentDescriptioninputListThe list to turn into a markdown unordered listInlineCodeThis object returns a markdown inline code string (code content)CallInlineCode()with the needed argumentThere is no functions for the InlineCodeobject.ArgumentDescriptioncodeThe content of the inline codeBlockCodeThis object returns a markdown code block (code)CallCodeBlock()with the needed argumentThere is no functions for the BlockCodeobject.ArgumentDescriptioncodeThe content of the block codelanguage(optional) The language of the code if your markdown preprocessor is able to do syntax highlighting (normally it can)SeparatorThis object returns a markdown separator (---)CallSeparator()with the needed argumentThere is no functions for the Separatorobject.There is no arguments to pass for the Separatorobject.LinkThis object returns a markdown link (title)CallLink()with the needed argumentThere is no functions for the Linkobject.ArgumentDescriptionlinkThe linktitle(optional) a title for the link which will be displayed to the user instead of the full linkhoverTitleA title for the link which will be displayed when the user hovers the linkImageThis object returns a markdown image (![alt text](image URL))CallImage()with the needed argumentThere is no functions for the Imageobject.ArgumentDescriptionURLThe URL of the imagealt_text(optional) An alt text for the image (by default it is the name found on the given URL)TableThis object returns a markdown table (headervalueCallTable()with the needed argumentThere is no functions for the Tableobject.ArgumentDescriptionheadersA list of headersvaluesA list of lists of valuesalignement(optional) the alignement for the table (could be a string (left, center or right) or a list to define the alignement of each column)FootnoteThis object returns a markdown footnote (text[^1]    and then at the end of the file [^1]: note)CallFootnote()with the needed argumentThere is no functions for the Footnoteobject.ArgumentDescriptionnoteThe content of the notemarkdownObjThe markdown object you want to append the footnote to (it will be added at render time)HeadingIDThis object returns a markdown heading id ({#id})CallHeadingID()with the needed argumentThere is no functions for the HeadingIDobject.ArgumentDescriptionidThe new Heading IDcorrectSyntaxIf you want to correct the syntax of the ID (incomplete for now)DefinitionThis object returns a markdown definition (word: definition)CallDefinition()with the needed argumentThere is no functions for the Definitionobject.ArgumentDescriptionwordThe word to definedefinitionEither a string for one definition or a list of multiple definitionsStrikethroughThis object returns a markdown strikethrough text (text)CallStrikethrough()with the needed argumentThere is no functions for the Strikethroughobject.ArgumentDescriptiontextThe text to strikethroughTaskListThis object returns a markdown tasklist ([x] do something)CallTaskList()with the needed argumentFunctionsDescriptionArgumentsReturned ValueaddTask()Adds a task to the TaskListtask: The task; checked (optional): Wether it is checkedNothingArgumentDescriptiontaskThe taskcheckedWether it is checked or notParagraphThis object returns a markdown paragraph (text)CallParagraph()with the needed argumentThere is no functions for the Paragraphobject.ArgumentDescriptiontextThe content of the paragraphBoldTextThis object returns a markdown bold text (text)CallBoldText()with the needed argumentThere is no functions for the BoldTextobject.ArgumentDescriptiontextThe textItalicTextThis object returns a markdown italic text (text)CallItalicText()with the needed argumentThere is no functions for the ItalicTextobject.ArgumentDescriptiontextThe textBoldAndItalicTextThis object returns a markdown bold and italic text (text)CallBoldAndItalicText()with the needed argumentThere is no functions for the BoldAndItalicTextobject.ArgumentDescriptiontextThe textTableOfContentThis object returns a markdown table of content (HeaderSomethingHeaderSomething else)CallTableOfContent()with the needed argumentThere is no functions for the TableOfContentobject.ArgumentDescriptionmarkdownObjThe MarkdownFile objectlevelThe maximum level of heading to includeDependenciesHere is a list of the depencies used by markdown-creationThey are automatically downloaded if you install it through pipThese dependencies are only used to convert the markdown file to HTMLmarkdown - to convert markdown to htmlbeautifulsoup4 - to prettify the htmlhtmlmin - to minify the htmlBy the wayThis whole file was created with markdown-creation (the creation script iscreateDocs.py)© Anime no Sekai - 2020