github-error-solve icon indicating copy to clipboard operation
github-error-solve copied to clipboard

[FEATURE] Create Documentation Page from MD/YAML Files

Open devvsakib opened this issue 7 months ago • 1 comments

Description

Implement a feature that generates a documentation page from Markdown (MD) and YAML files. A folder named post will be created in the root directory, containing all the MD/YAML files. The documentation page will display a list of these files with their titles. When a user clicks on a title, they will be navigated to a detailed page where the content of the MD/YAML file is presented in a well-decorated and readable UI.

Tasks

  1. Folder Setup:

    • Create a post folder in the root directory to store all MD/YAML files.
  2. List View Implementation:

    • Fetch and display a list of MD/YAML files from the post folder on the documentation page.
    • Extract and display the title from each file's metadata or content.
  3. Detail View Implementation:

    • Implement navigation to a single page when a file title is clicked.
    • Render the content of the selected MD/YAML file in a clean and readable format.
    • Apply styling to ensure the content is visually appealing and easy to read.
  4. UI/UX Enhancements:

    • Design and apply a consistent UI theme for both the list and detail views.
    • Include features like code highlighting, tables, and other MD/YAML formatting elements for better readability.
  5. Testing:

    • Test the feature for different file types and structures.
    • Ensure compatibility across various browsers and devices.

Additional Information

  • Provide a clear structure for the MD/YAML files to ensure consistent extraction of titles and content.
  • Attach screenshots or mockups if available, to provide a visual reference for the expected UI.

Expected Outcome: A fully functional documentation page that lists all MD/YAML files from the post folder and allows users to view the content in a well-decorated format.


Please feel free to add or modify any details as needed. We look forward to seeing this feature implemented!

devvsakib avatar Jul 27 '24 06:07 devvsakib