Comments (12)
I guess there’s no way to have Previous/Next Doc linked at the bottom of every markdown file unless we “hardcode” that in the md, @HadrienGardeur?
We’ve been using the md files to generate an EPUB file so far… consequently, it would have to be removed if we keep on providing this EPUB file.
from readium-css.
@JayPanoz this feels a lot like a discussion about Web Publications 😇
There's indeed no automatic way to have previous/next doc links by default (there's no such concept on the Web or on Github).
You'd have to manually add them and I guess hide them using CSS in the generated EPUB file.
If you'd like to get even more experimental, you could also go full WP on these pages and include a manifest + JS to generate such navigation.
from readium-css.
Well after some additional research, GitHub would probably answer this is what Jekyll is for, indeed.
I’ll check what the most sustainable option could be.
from readium-css.
Yes, Jekyll is the way to go. But it means moving the readium-css pages to the github.io repo IMO. We tried other ways (reference, inclusion) which were not practical.
from readium-css.
@llemeurfr you've missed the last two calls I think and during the first one, I actually started using the same Markdown files in architecture for the repo and the website at the same time: https://readium.org/architecture
IMO it is much better to avoid duplicating the effort of presenting these projects than forcing ourselves to use a separate repo just for the sake of keeping the design consistent with the same header/footer.
from readium-css.
Clarification: Jekyll’s running behind the scenes anyway, no? Only does it treat assets (.md files) as static when creating github pages as far as I can understand.
So I was wondering if you could say use include
without generating all the files it needs (i.e. overriding the hidden Github’s ones). That said, it won’t help with EPUB conversion but I can now remember I had to do some manual edits anyway…
from readium-css.
So yes it’s using Jekyll Default Layout, cf.
- Publishing with GitHub Pages, now as easy as 1, 2, 3
- Getting Started with GitHub Pages
- Where does the head section come from when github pages generates source?
from readium-css.
Alright got the default github-pages config running locally by following those instructions.
Since I didn’t want to add this repo as origin yet, the trick is to create a _config.yaml
file with repository: <usr>/<local-repo-name>
so that bundle exec jekyll serve
can run and serve the pages @ localhost:4000
.
It’s my understanding everything is generated as static assets in a _site
folder, cf.
Note there’s only a CSS file added as an asset, no JS, nothing.
I’ll try adding some stuff to see if you can build on top of the default config.
from readium-css.
Looks like you can so I’ll give it a deeper look next week.
There’s probably a way to handle that using templates so that includes don’t pollute markdown.
from readium-css.
Unless I’m missing something, which is quite possible given the amount of commits I’ve just made to correct paths and stuff, master/docs
must not follow the repository naming scheme <username>.github.io or <orgname>.github.io.
Problem is it automatically does when switching to master/docs
as the source of github pages and will look for a CNAME in this folder.
So I added a link in the ReadMe + an index in the docs
folder with a TOC.
from readium-css.
BTW @llemeurfr, as quickly discussed with Hadrien through Slack, there may be a possibility to have the Readium.org layout/theme on all subdomain/project pages but that implies to make it a theme available as a gem so that project pages can reference it in the Jekyll config – or alternatively a repo on its own but I’m really not sure about this option.
from readium-css.
Setup done so an hypothetical update should be another issue.
from readium-css.
Related Issues (20)
- CSS HTML5 patch causes some digits to descent from baseline HOT 4
- CSS HTML5 patch causes some digits to descent from baseline
- CSS HTML5 patch causes some digits to descent from baseline
- Long hyperlinks overlap on the next column HOT 3
- forcing "start" text alignment (left or right depending on document language) does not work with "inherit" HOT 1
- Overflow on long words HOT 4
- in scroll mode, "page width" (line length) is too short HOT 19
- Target for Browser/Webview support? HOT 3
- Dist stylesheets and minification HOT 4
- Default Stylesheet for non-reflowable EPUB contents e.g. reading mode
- ReadiumCSS Reset/Unset
- Fonts update HOT 2
- Letter-spacing for japanese HOT 9
- Overview of new CSS specs of interest HOT 2
- Improve handling of body overflow HOT 1
- Defining design guidelines based on CSS support HOT 2
- User setting to disable/hide ruby
- Park support of pagination for vertical writing
- Remove responsive columns to make pagination more reliable HOT 8
- More often than not, "cover" images (first spine item in the reading order, full-page picture) cause excess blank before/after HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from readium-css.