Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ivanhercaz/buruma

a Pelican theme with Bulma (CSS Framework)
https://github.com/ivanhercaz/buruma

bulma bulma-css bulma-css-framework pelican pelican-4 pelican-theme theme

Last synced: 26 days ago
JSON representation

a Pelican theme with Bulma (CSS Framework)

Awesome Lists containing this project

README 

        


  

    Buruma Logo

  





  

    Netlify Status

  

  

    Gitmoji

  

  

    gitmoji-changelog

  




## Abandoned project notice



I would like that anyone interested on this project read this notice before to spend time configuring and using Buruma for a project.



**TLDR**: I abandoned the project because I am not motivated to continue it and I am migrating progressively my projects built with Pelican. Anyone interested in continue this project is more than welcome. If this is the case, you can contact with me if you have some doubt that I can solve.



There are some issues open, mainly enhancements. I try to keep track of all the ideas I had when I was working on Buruma. If I get more free time, I will create an issue to look for a new maintainer. At the moment I am writting this there are two forks with some commits ahead:



- [psychonaute/buruma](https://github.com/psychonaute/buruma). Reading the commits, this one seems to add some interesting enhancements like "Bulma Timeline" and "Bulma Accordion".

- [Marusoftware/bulma-pelican-theme](https://github.com/Marusoftware/bulma-pelican-theme).



Of course, before to use them check them and ask any doubt you have to them, to know if their projects fit with your needs.



I want to take advantage to thanks to Pelican contributors for all their work. Pelican helped me a lot and I really like it. But now I have other interests and I want to migrate to another static site generator just to support my learning of my new interests.



## Introduction



Buruma is a [Pelican](https://github.com/getpelican/pelican) theme built with the CSS framework [Bulma](https://bulma.io).



The current version is the [0.2.3](https://github.com/ivanhercaz/buruma/releases/tag/v0.2.3). 



If you want to use Buruma, I recommend you to read the available [quickstart](https://buruma.ivanhercaz.com/quickstart) in the documentation website, because it might help you to decide if Buruma is fine for you at this moment.



## Documentation



It is available in the [documentation website](https://buruma.ivanhercaz.com). If you want to test Buruma, you may be interested in the [quickstart](https://buruma.ivanhercaz.com/quickstart). There is a page dedicated to Buruma [settings](https://buruma.ivanhercaz.com/settings.html).



If you note a lack in the documentation, please feel free to [open an issue!](https://github.com/ivanhercaz/buruma/issues/new).



## Demo website



You can check Buruma in its [demo website](https://netlify--affectionate-hypatia-0ab213.netlify.com/). It is deployed on Netlify and it always use the last stable release (not alpha nor beta).



If you want to check a website using Buruma updated to the master branch of this repository, you can check the [documentation](https://buruma.ivanhercaz.com). 



## Contributing



The contributing guidelines are not written yet, but if you want to contribute to Buruma in any way, do it! Your contributions will be very welcome!



## Credits



Buruma is possible thanks to [Jeremy Thomas](https://jgthms.com/), creator of [Bulma](https://bulma.io), released under the [MIT license](https://github.com/jgthms/bulma/blob/master/LICENSE). Of course, Buruma exists because [Pelican](https://getpelican.com) exists! An awesome and easy to use static site generator.



## License



Buruma is under [GNU Affero General Public License v3.0](https://github.com/ivanhercaz/buruma/blob/master/LICENSE). Should Buruma be under another license? If you think that, feel free to open an issue to discuss it!