Configure logo for ReadTheDocs site using MkDocs engine - read-the-docs

Maybe a missing feature; not sure.
How would we go about adding the site/project logo top left in a ReadTheDocs site using the MkDocs engine?
At https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html#adding-a-logo (and some SO questions) it appears configuring logo is unrelated to RTD or MkDocs but is actually targeting the Sphinx RTD theme.

Related

Wordpress Oceanwp happen or not in my website

If I use free ocean wp theme in my commercial website then any copyright will be happen or not.
P
I hope I am getting your question right. What I understand is the following:
You want to use a Theme which is freely available via WP Theme repository in your WordPress Website.
This is the desired theme: https://de.wordpress.org/themes/oceanwp/
The Theme supports WooCommerce as described under above link.
My answer:
you may use any theme which can be found in WP theme repository on your WordPress website.
Best
Saskia

Including images with a Jekyll theme

When creating a Jekyll theme, how can I include images with the theme?
These can be background images, icons, social buttons, and images that belongs to the theme and not to the site.
I have tried adding a folder with images to the theme but the generated site (that's using the theme) doesn't serve it.
Apparently this is not possible yet, expected to arrive with 3.3, see here:
https://github.com/jekyll/jekyll/issues/5341

how do I install a theme using Jekyll 3.1 and octopress plugins?

I am still using the default Octopress 3 theme, but would like to use Jekyll themes The instructions online, though, suggest that I fork a theme, change the _config file, and then add my content.
It seems like, since the themes should just be sass and _layout, I should be able to install those files and have a new theme.
I haven't seen clearer examples or documentation on that.
Posting here per the jekyll website.
Generally, the best way is to fork the theme, and copy over your content in the _posts folder, and your _config file, as per this answer.
It would also be possible to copy over the theme files into the _sass, css, _includes and _layouts folders, since this is where the theme rests, but this would mean a) more work and b) you can quite easily mess it up. Oh, and the js folder, the index.html file, any other pages not using the page layout...
Ultimately, Jekyll is not like Wordpress; It's not easy to just drop in a new theme.
Forking a jekyll theme just for using it is not a good practice, even github has recognised it and now provides the template type. Forking is good mainly for contributing back to the original.
The easiest way to switch theme on an existing or new jekyll installation is to use the following plugin: jekyll-remote-theme, which is available since November 2017.
The remote_theme method is almost similar to Wordpress usability, instead of clicking around you have to type-in the name of the new theme in the config file. You do not need to fork a theme or touch any of the style files.
This is an elegant solution, because in the long term you prefer the experts (i.e., the theme maintainer) to handle bugs and new version in the theme, while you can focus on your content.
If you have a custom theme with new and elaborate layouts then the switch might take some more manual work

Jekyll: What is the difference between Jekyll and Jekyll bootstrap?

I'm confused at the relationship between jekyll and jekyll bootstrap. I'd like to start a blog and I'm not really sure which site to use for tutorials and whatnot.
Jekyll is the main thing. It's what generates your markdown and templates into static html pages.
Jekyll Bootstrap is just a project that helps you make Jekyll sites faster/better. It uses Twitter Bootstrap, which you could totally do on your own.
And it's got stuff like rake tasks to make it easier to create new posts, and pages. For example, you can create a new post like this: rake post title="Hello World".
Unfortunately, Jekyll Bootstrap is no longer maintained because the author created his own static site generator.
I would just start with plain Jekyll if I were you, but there are probably some great ideas you can take from Jekyll Bootstrap. For instance, if you like Twitter Bootstrap, it's a great idea to include that in your site. Also, those rake tasks could be handy. It can be a pain creating new posts since the filename required by Jekyll is _posts/YYY-MM-DD-slug-of-the-post.md.
Jekyll is a static site generator.
Twitter Bootstrap is a HTML/CSS/JS framework that allows you to quickly create the most common GUI elements in your browser, like menu bars, tabs, buttons, etc.
Jekyll Bootstrap is a collection of turn-key Jekyll themes for Github pages, which are all based on the Twitter Bootstrap framework.
Note that Jekyll Bootstrap is no longer maintained. Therefore, these themes might not work as expected, because Github periodically upgrades their Jekyll version.
Jekyll is a compiler like for C++ or VB.NET. Jekyll-bootstrap is a open source project with Hello World website made using twitter bootstrap library (this is jquery library to make site responsive - adjust to screen size).
Now you can have your own site structure and use twitter bootstrap in any jekyll post or page as shown here. So don't go for 3rd party project where you've to spent time digging into code.

How to convert a Jekyll theme to Octopress theme

I started fiddling with Octopress recently, and I found a theme for Jekyll that I liked it.
The problem is that this theme doesn't have a similar structure that Octopress needs for themes.
I tried to clone the repo directly into my Octopress folder then use rake install['name-of-theme'] but that didn't work and I just got some errors about missing folders (source, sass).
So my question(s) is, how to install a theme for Jekyll with Octopress? is there a directory structure I need to follow? what are the minimum files requires to make it work?
I Googled a little bit but I didn't find anything related to converting a Jekyll theme.
Thanks.
You can't. The author of Octopress made his own theme layout and plugins to support it. Jekyll is meant for you to create your own theme layout as you wish (it's barebones). Think of Jekyll as a great framework to write your own static site, a store front or a wiki or a blog - from scratch. Octopress, on the other hand though, adds a framework on top of Jekyll: theme layout, a number of plugins defaulted for a blog site, SEO throughout the templates, a config file for controlling this framework-on-top-of-a-framework (Octopress framework on top of Jekyll framework). Basically, you can take Jekyll and write your own theme layout any way you wish; but with Octopress, you already have a strict theme layout to adhere to.
Octopress' rake install[] command to install a theme just copies a bunch of files to specific directories, following the authors specific theme format.
He's also changing the format from time to time as well, which usually breaks even older Octopress themes working on current Octopress sites (doesn't seem to worry about backwards compatibility). I know: I really tried some old responsive ones I found only to get errors with the latest Octopress as of April 2014.
Anyhoot, after many tries, I finally just sat down and copy-n-pasted the HTML into a new Octopress theme manually myself. Created my own "theme" to try to get some older Octopress themes working.
Still didn't like it as it was buggy (and I was trying several older Octopress themes); so, I gave up and just wrote my own Octopress theme from scratch and moved on. Personally, I don't like how Octopress' layout is, well, laid out. Far too many freakin incremental files. I basically just built my own from scratch and skipped several of the "custom" stuff. This allowed me the freedom of mocking up my own raw responsive set of HTML files and organize it how I wish (http://eduncan911.com).
I understand why he added the custom stuff in the last few months: for people that don't know much about frontend or just wanted a quick place to tweak this font, change that color, or just add a JS script to the custom footer and be done with a plugin.
Me? I already had a full HTML/JSS responsive HTML mockup I wanted to use. I only needed to utilitze Octopress' articles and show/hide the pagenation and comments. I didn't need that elaborate Octopress template layout. Though, now if anyone wants my theme, they can only copy exactly what I did and will need to modify it as they want. I did keep the SCSS generation though, as I like SCSS.
https://github.com/eduncan911/eduncan911.github.io/tree/source