Skip to content

Add Docsify web viewer and search functionality for PostgreSQL docs#23

Merged
fahimahammed merged 2 commits intofahimahammed:mainfrom
mathncode-sid:docs-web-viewer
Oct 4, 2025
Merged

Add Docsify web viewer and search functionality for PostgreSQL docs#23
fahimahammed merged 2 commits intofahimahammed:mainfrom
mathncode-sid:docs-web-viewer

Conversation

@mathncode-sid
Copy link
Contributor

@mathncode-sid mathncode-sid commented Oct 4, 2025

Pull Request for Issue #20 and #21 : Add Web Viewer and Downloadable PDF with Branding

Description

This PR enhances the repository by improving accessibility and user experience for the existing PostgreSQL documentation.

Features Added

  • Web Viewer

    • Markdown files are now rendered in a clean, responsive web view using Docsify.
    • Sidebar navigation is included for easy movement between sections.
  • Search Functionality

    • Users can quickly search within the documentation via the search bar.
      This sorts out Issue #21

Files Added

  • index.html → main Docsify web viewer.
  • _sidebar.md → sidebar navigation for all documentation sections.
  • assets/custom.css → custom styling for the Docsify site.

Notes on Downloadable PDF

  • Downloadable PDF functionality was explored but could not be fully implemented due to limitations with dynamic Docsify content and hosting constraints.
  • For a full PDF with branding, it is recommended to pre-generate the PDF locally using a tool like Puppeteer and include it in the repository, with a link for download in the sidebar or README.

Hosting on GitHub Pages

  • With the addition of index.html, the documentation can now be hosted on GitHub Pages.

  • To host:

    1. Push the repository to GitHub.
    2. In the repository settings, enable GitHub Pages, typically from the main or gh-pages branch.
    3. Access the hosted site at https://fahimahammed.github.io/learn-postgresql/
  • This allows users to view the documentation directly in a web browser without cloning the repo.

Optional Enhancements for Future

  • Dark mode for web viewer.
  • Automatic Table of Contents generation from markdown headers.
  • Versioning support for different documentation updates.

This PR lays the foundation for a more interactive, accessible, and professional documentation experience, following the proposal outlined in Issue #20 and Issue #21

Screenshot

image

…L docs

- Added  for Docsify web view
- Added  for sidebar navigation
- Added  for styling
- Enabled search functionality
- PDF download explored but not implemented
- Prepared repo for GitHub Pages hosting
@fahimahammed fahimahammed merged commit d63fcab into fahimahammed:main Oct 4, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants