jekyll-kw-stackexchange

A plugin for jekyll to ... TODO: Add the project description here

🔥 Usage

⚙️ Configuration

Add jekyll-kw-stackexchange section to _config.yml configure the plugin globally, see jekyll-documentation. If you want to use defaults you can omit the config-section.

jekyll-kw-stackexchange:
  user_id: 14754800
  api_baseurl: "https://api.stackexchange.com/2.3"

Configuration values, the default value is in bold

Key	Description	Values (default)
user_id	your user-id from StackExchange as number	14754800
api_baseurl	The base-url to the API of StackExchange	https://api.stackexchange.com/2.3

🚀 Installation

Add this section to your application's Gemfile inside the jekyll_plugins and execute bundle install

group :jekyll_plugins do
  gem 'jekyll-kw-stackexchange'
end

Or install the dependency with bundle itself, you can use the option --skip-install, when bundle install will be called later

bundle add jekyll-kw-stackexchange --group jekyll_plugins 

Then add the following to your site's _config.yml to activate the plugin, see also the Configuration section to change the default configuration.

plugins:
  - jekyll-kw-stackexchange

The Plug-In is tested with ruby v3.1 jekyll v4.2!

Local linting and testing

• Run linting bundle exec rubocop.
• Run tests bundle exec rake test.

⏰ Changelog

• ...
• Prepare CI-workflow with Appraisal bundle exec appraisal install and bundle exec appraisal generate
• Rubocop rubocop --display-cop-names --format markdown -o rubocop.md --format html -o rubocop.html --format simple
• Rubocop -> rubocop --display-cop-names --format markdown -o rubocop.md --format html -o rubocop.html --format progress --format offenses
• Prepare workflow on GitHub CI and rubocop
• 0.0.1 Install Visual Studio Extension - Folder Templates, and run NewJekyllPlugInAsRubyGem to get the a skeleton project from template
• 0.0.0 Create project jekyll-kw-stackexchange from template

📝 Notes / Hints

TODO: Add notes, hints and learnings

👋 Contribution

TODO: How to contribute, e.g. CONTRIBUTING.md

🏆 Kudos

TODO: Add big thanks and kudos persons / links / blogs

✅ Template

The project was created from the template GitHub n13org/jekyll-plugin-template. We would ❤️ when you keep the reference. Thanks. TODO: Create hint to start a Pull Request to the "Who Is Using" ...

To update code from template or provide ideas to the template, add the template as second git remote, via git add remote template [email protected]:n13org/jekyll-plugin-template.git. Create a branch git checkout -b update-template. Change the code and push it git push template update-template. Navigate to the Pull request area on GitHub website.