compiiile

The most convenient way to render a folder containing markdown files. Previewing and searching markdown files has never been that easy.

GPL-3.0 License

Downloads
3.2K
Stars
141
Committers
4

Bot releases are hidden (Show)

compiiile - 2.14.0 - Handle .compiiileignore and added hidden frontmatter key Latest Release

Published by AlbanCrepel about 1 month ago

This new release is the result of a feature request, you can now:

  • Ignore files and folders based on glob patterns in a .compiiileignore file placed at the root of your folder where you run Compiiile,
  • Hide a file from the navbar and siblings links navigation by setting hidden: true in the frontmatter of a file.

Enjoy ✨

compiiile - 2.13.2 - Load config with c12 and add link to compiiile-print integration

Published by AlbanCrepel 3 months ago

  • πŸ”₯ Loading the config file with c12 allows to extend configs from other files
  • ✨ A new official Compiiile integration has been published : compiiile-print, which adds a route to display all Compiiile files and print them, with custom headers and pagination

Enjoy πŸ™†β€β™€οΈ

compiiile - 2.10.0 - Handling symlinks

Published by AlbanCrepel 7 months ago

  • ✨ You can now reuse content by using native symlinks
  • 🌈 Current slide theme can be overwritten by setting the theme query parameter to light or dark
compiiile - 2.8.0 - Sitemap generation and robots indexation

Published by AlbanCrepel 7 months ago

  • πŸ™†β€β™€οΈ Added sitemap generation when siteUrl compiiile's parameter is set
  • ⚑ Added a noIndex parameter to allow or disallow pages' indexation
compiiile - Theme switcher + useAutoTitles + index.md

Published by AlbanCrepel 8 months ago

πŸ™†β€β™€οΈ This is quite a HUGE update !

  • 🌈 Compiiile now has the ability to switch between a light and a dark theme
  • πŸ’… Dark theme colours have been reworked
  • ⚑ Added the useAutoTitles config param to automatically set the first heading of the file as the title to be displayed in the navbar and for SEO
  • 🌟 The home page fallbacks to an index.md file if no README.md file is present

Enjoy πŸ”₯

compiiile - Added site data and improved slides style

Published by AlbanCrepel 8 months ago

  • 🌟 You can now add data to your config and it will be available in your MDX files.
  • πŸ’… Slides style have been improved:
    • wider content without scaling from reveal.js
    • bigger titles
    • textAlign can be changed globally with frontmatter
compiiile - 2.2.0 - Updating dependencies

Published by AlbanCrepel 10 months ago

πŸ™†β€β™€οΈ Here is the list of the changes:

  • updating astro version to the latest
  • putting config file aside
  • adding margins to titles
  • added logoUrl argument
  • using a proper organization
  • slidesContent no more using v-show
compiiile - 2.1.2 - Handle base url and generate style

Published by AlbanCrepel 12 months ago

πŸ”₯ New features:

  1. Compiiile can now be generated under a base url on your web server, like /documentation.
    All you have to do is add this key at the root of your compiiile.config.js file:
{
  "astroConfig": {
    "base": "/documentation/"
  }
}
  1. Compiiile's style can also be used by importing it :
import "compiiile/dist/style.css"
compiiile - 2.0.6 - Hot reload and MDX support | now using Astro

Published by AlbanCrepel about 1 year ago

πŸŽ‰ This is a new milestone reached ! The project has been completely rewritten with Astro ⚑. Is it blazing fast ? Yes it is...

πŸ”₯ These awaited features are now available:

  • Hot reload: preview your changes while editing your Markdown files
  • MDX support: use Vue components in your files

πŸ‘€ Have a look at the CHANGELOG.md file at the project root for a more detailed description of the changes.

Make sure to update your package version, and support my open-source work via donations if you feel this project is useful to you ❀️.

compiiile - 1.0.16 - Fix image resolving

Published by AlbanCrepel about 1 year ago

πŸ”§ This release fixes local image resolving

compiiile - 1.0.15 Readme on FileTree top

Published by AlbanCrepel over 1 year ago

compiiile - 1.0.14 using relative assets paths

Published by AlbanCrepel over 1 year ago

compiiile - Fix logo and title position

Published by AlbanCrepel over 1 year ago

compiiile - 1.0.12

Published by AlbanCrepel almost 2 years ago

  • : wrench: fix cross-links for non-latin characters
compiiile - 1.0.10

Published by AlbanCrepel almost 2 years ago

  • πŸ”§ fix capitalize wording in documentation
compiiile - 1.0.9

Published by AlbanCrepel almost 2 years ago

  • πŸ”§ Fix encoded url with non-latin languages
compiiile - 1.0.8

Published by AlbanCrepel almost 2 years ago

  • πŸ”§ fix search result click
  • πŸ“š added a quick start documentation
compiiile - 1.0.2

Published by AlbanCrepel almost 2 years ago

πŸ”§ fixing dependencies:

  • getting rid of the phosphor-vue lib because it was incompatible with the latest version of vue
  • now using vite not as a dev-dependency
compiiile - 1.0.0

Published by AlbanCrepel almost 2 years ago

This first release (πŸŽ‰) includes the one-year work to publish the 1.0.0 version of Compiiile. It includes all the basics to get things working, like:

  • previewing markdown files and displaying them as slides
  • 3 commands to develop, build, and preview the project
  • navigation working out of the box without configuration
  • search through all files

This makes previewing markdown a lovely experience without hassle ❀️.

Package Rankings
Top 39.47% on Npmjs.org
Top 6.73% on Proxy.golang.org