qwxlea / logseq-plugin-starter-template

A quick and easy to use template to get you going from the get go

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url]

{{% plugin-title %}}

An awesome plugin!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Installation
3. Configuration
4. Using the plugin
5. Issues
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

[![Product Name Screen Shot][product-screenshot]](https://github.com/{{% github-id %}}/{{% plugin-name %}}/)

Short description of the plugin goes here.

(back to top)

Installation

Preparation

• Click the 3 dots in the righthand corner and go to Settings.
• Go to Advanced and enable Plug-in system.
• Restart the application.
• Click 3 dots and go to Plugins (or Esc t p).

Install plugin from the Marketplace (recommended)

• Click the Marketplace button and then click Plugins.
• Find the plugin and click Install.

Install plugin manually

• Download a released version assets from Github.
• Unzip it.
• Click Load unpacked plugin, and select destination directory to the unzipped folder.

(back to top)

Configuration

• Click the 3 dots in the righthand corner and go to Settings.
• Go to Plugin Settings.
• Select correct plugin.

![Configuration screen][configuration-screenshot]

(back to top)

Using the plugin

(back to top)

Issues

See the [open issues](https://github.com/{{% github-id %}}/{{% plugin-name %}}/issues) for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

Image license

Font License

OFL

(back to top)

Contact

{{% plugin-owner %}} - {{% plugin-contact %}}

Project Link: [https://github.com/{{% github-id %}}/{{% plugin-name %}}](https://github.com/{{% github-id %}}A/{{% plugin-name %}})

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/{{% github-id %}}/{{% plugin-name %}}.svg?style=for-the-badge [contributors-url]: https://github.com/{{% github-id %}}/{{% plugin-name %}}/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/{{% github-id %}}/{{% plugin-name %}}.svg?style=for-the-badge [forks-url]: https://github.com/{{% github-id %}}/{{% plugin-name %}}/network/members [stars-shield]: https://img.shields.io/github/stars/{{% github-id %}}/{{% plugin-name %}}.svg?style=for-the-badge [stars-url]: https://github.com/{{% github-id %}}/{{% plugin-name %}}/stargazers [issues-shield]: https://img.shields.io/github/issues/{{% github-id %}}/{{% plugin-name %}}.svg?style=for-the-badge [issues-url]: https://github.com/{{% github-id %}}/{{% plugin-name %}}/issues [license-shield]: https://img.shields.io/github/license/{{% github-id %}}/{{% plugin-name %}}.svg?style=for-the-badge [license-url]: https://github.com/{{% github-id %}}/{{% plugin-name %}}/blob/master/LICENSE.txt [product-screenshot]: ./images/screenshot.png [configuration-screenshot]: ./images/configuration.png