mm-mark 0.2.0 → 0.2.1

package/.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+name: Publish
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Publish package
+        run: npx jsr publish

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # mm-mark
 
+## 0.2.1
+
+### Patch Changes
+
+- Remove ptm frontmatter
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -1,29 +1,128 @@
 import showdown from 'showdown';
 
+/**
+ * Convert markdown file to HTML content.
+ * ----------
+ *
+ * ***Base on Showndown JS and TeX,  LaTeX,  MathMl, Prism JS are support.***
+ *
+ * @example
+ * const converter = new Converter(_PATH_TO_MARKDOWN_FILE);
+ *
+ *
+ *
+ * @return
+ * - json : {data: *frontmatter*, content: markdown content(before convert)}
+ * - data : frontmatter , default  date and title
+ * - content :  markdown content(before convert)
+ * - postTitle : Title of post from data(frontmatter)
+ * - postDate : Posted date from data(frontmatter)
+ * - lastUpdatedDate : Last updated date of content
+ * - readingTime : Reading time of content
+ * - convertedContent : Converted content.
+ * - postHtml : HTML with convertedContent , postTitle ,
+ *              postDate , lastUpdatedDate , readingTime
+ *              (for blog post)
+ * - pageHtml : HTML with only convertedContent for page
+ *
+ */
 declare class Converter {
     filePath: string;
+    /**
+     * Creates an instance of the Converter class.
+     *
+     * @param {string} filePath - The path of the file to be converted.
+     */
     constructor(filePath: string);
+    /**
+     * Formats a given date string into a specific format.
+     * @param date - The date string to be formatted.
+     * @returns The formatted date string in the format "Weekday, Day Month Year". For example, "Sat, 01 Jan 2022".
+     */
     formatDate(date: string): string;
+    /**
+     * Calculates the estimated reading time of a given text.
+     *
+     * @param {string} text - The text to calculate the reading time for.
+     * @return {number} The estimated reading time in minutes.
+     */
     readTime(text: string): number;
+    /**
+     * Retrieves the last update time of a file.
+     *
+     * @return {string} The last modified time of the file in ISO string format.
+     */
     lastUpdate(): string;
     /**
      * Initializes and configures a showdown.Converter object with specific options and flavor.
      * @returns {showdown.Converter} The initialized converter object.
      */
     convert(): showdown.Converter;
-    filecontent(): {
-        data: any;
-        content: any;
-    };
+    /**
+     * Retrieves the content of the file using frontmatter.
+     *
+     * @return {any} The frontmatter content of the file.
+     */
+    filecontent(): any;
+    /**
+     * Retrieves the data from the frontmatter of the file at the specified file path.
+     *
+     * @return {any} The data retrieved from the frontmatter of the file.
+     */
     get data(): any;
+    /**
+     * Retrieves the content from the frontmatter of the file at the specified file path.
+     *
+     * @return {any} The content retrieved from the frontmatter of the file.
+     */
     get content(): any;
+    /**
+     * Retrieves the post title from the data object.
+     *
+     * @return {any} The post title.
+     */
     get postTitle(): any;
-    get postDate(): string;
+    /**
+     * Retrieves the post date from the data object.
+     *
+     * @return {any} The post date.
+     */
+    get postDate(): any;
+    /**
+     * Retrieves the last updated date of the content.
+     *
+     * @return {string} The formatted last updated date string.
+     */
     get lastUpdatedDate(): string;
+    /**
+     * Calculates the estimated reading time of the content and returns it as a formatted string.
+     *
+     * @return {string} The formatted string representing the reading time.
+     */
     get readingTime(): string;
+    /**
+     * Returns a JSON string representation of the file content.
+     *
+     * @return {string} The JSON string representation of the file content.
+     */
     get json(): string;
+    /**
+     * Returns the converted content of the object as a string.
+     *
+     * @return {string} The converted content as a string.
+     */
     get convertedContent(): string;
+    /**
+     * Retrieves the post HTML content with converted content, title, date, reading time, and last update.
+     *
+     * @return {string} The post HTML content.
+     */
     get postHtml(): string;
+    /**
+     * Retrieves the page HTML content with converted content, title, date, reading time, and last update.
+     *
+     * @return {string} The page HTML content.
+     */
     get pageHtml(): string;
 }