Jekyll plugin for Astronauts.
Spaceship is a minimalistic, powerful and extremely customizable Jekyll plugin. It combines everything you may need for convenient work, without unnecessary complications, like a real spaceship.
Table of Contents
Requirements
Ruby = 2.3.0
Installation
To install the jekyll-spaceship plugin, add the following line to your site’s Gemfile:
group :jekyll_plugins do
gem 'jekyll-spaceship'
end Or, if you prefer a single line:
gem 'jekyll-spaceship', group: :jekyll_plugins Then add jekyll-spaceship to your plugins section in the site’s _config.yml:
plugins:
- jekyll-spaceship Configuration
This plugin runs with the following configuration options by default, which can be modified in the _config.yml:
jekyll-spaceship:
processors:
- table-processor
- mathjax-processor
- plantuml-processor
- mermaid-processor
- polyfill-processor
- media-processor
- emoji-processor
- element-processor Usage
With Jekyll Spaceship, you can extend your Markdown tables like a pro. Let me break it down using an analogy:
Think of building tables as assembling furniture. Just like a carpenter needs the right tools to create a beautiful piece, you need the right syntax to structure your tables effectively. Each ‘tool’ or feature allows you to manipulate your table with ease, whether it’s merging cells, aligning text, or even embedding formulas and diagrams!
The plugin enables advanced table functionalities, such as:
- Merging cells using
^^ - Displaying multiline text with a backslash
- Creating headerless tables
- Aligning cells individually
Math and Media Enhancements
In addition to tables, it also supports MathJax for math expressions and easy embedding for media such as videos and audios from various platforms like Youtube and Spotify.
Troubleshooting
If you run into any issues while using Jekyll Spaceship, here are some troubleshooting ideas:
- Ensure all dependencies are correctly installed and versions are compatible.
- If you encounter errors regarding plugins, verify if you are using the correct configuration in your _config.yml file.
- For GitHub Pages, remember it runs in safe mode, so build locally or use CI for deployment.
- Check the error logs for specific issues and refer to the documentation for any configuration changes.
For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.
Credits
License
This software is licensed under the MIT license.
At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.