/pulsar

Create modern documentation websites for your application using Pulsar. You will generate custom static documentation pages with Pulsar and can use them wherever you want.

Primary LanguageVueGNU General Public License v3.0GPL-3.0

pulsar-icon
GitHub package.json version (branch) GitHub top language GitHub closed pull requests GitHub Website

Pulsar is a powerfull documentation online editor

Pulsar is the ultimate solution for streamlining documentation page creation. With its intuitive interface and powerful features, Pulsar allows you to quickly and efficiently build documentation pages. Organize information, add content effortlessly, and deliver a seamless documentation experience for your users.

Getting startedCloning RepositoryContribute



Getting Started

Getting Started with Pulsar, your gateway to efficient online documentation editing. If you're ready to embark on a journey of creating impeccable documentation pages, you've come to the right place. You can access the project on this url

https://pulsar.diogopereira.tech


Project To-do-List

  • Create the feature to the user host documentations on Pulsar - branch: v2.0.0
  • Implement TDD to API routes
  • Create Pulsar own markdown editor and remove Tiptap
  • Add notes blocks to the editor
  • Upgrade the usability and customization of tables on editor
  • Remove some PrimeVue things like inputs and buttons, because is lagging on mobile devices
  • Upgrade the editor page interface
  • Upgrade the customizations page interface
  • Add the feature flag to search for pages on navigation menu of pages preview/doc
  • Create a templates area on editor page, to agilize the documentation creation process
  • Integrate the editor with an AI

Cloning Repository

To run the project on your machine and contribute to the project, you can clone the repository and run the following commands:

git clone https://github.com/FhillSlinger/pulsar.git

Move to the folder:

cd pulsar

Install the dependencies using >pnpm:

pnpm install

And finally run the project in development mode:

pnpm dev

After execute the command pnpm dev, you can access the project in http://localhost:3000


Contribute

Please star the project and help the developer with a donation on Buy me a Coffe:


Buy Me A Coffee