GithubHelp home page GithubHelp logo

ea-tel / detel-book Goto Github PK

View Code? Open in Web Editor NEW
5.0 4.0 21.0 5.17 MB

Home Page: https://ea-tel.eu/detel-book/

License: Other

HTML 11.93% Ruby 0.46% SCSS 17.89% CSS 0.48% JavaScript 53.67% TeX 15.56%

detel-book's Issues

Social meta tags are needed

Currently,
When sharing links to book chapters on social media, default (and wrong) meta information is displayed (see screenshot).

Should be,

  • The meta information should display the title of a correct text. The text should either be the first line of the chapter text (different for each chapter) or the first sentence of the preface (same for all chapters).
  • The meta image should be our cover image: https://ea-tel.github.io/detel-book/assets/images/Cover.png

image

The element <strong> needs to be updated

Currently,
The element has the property font-weight = 300

image

image

Should be:
The element has the property font-weight should represent a bold font, so the value should be around 500.

Find a way to document and dispaly contributors

Commits are made by one person but there might be more contributors in the background that should also be mentioned. We should look for a way how to document and track who participated in which chapter. This documentation should also track the kind of contribution that an author made.

Make the DOI and/or URL clickable in the Bibliography

Currently:

The Bibliography is a bit user-unfrieldly, because it is presented as plain text. There are DOIs and URLs but they are not clickable.

Should be:

Both DOI and/or URL should be clickable in the Bibliography.

Make an example chapter

The example chapter should include

  • relevant markdown features like headlines, tables, figures, links and code sections
  • at least one reference and a citation for demonstrating bibtex
  • at least one of each design elements from the book (exercise, example, ...)

Reduce the font size of the running text in the chapters

Currently,

  • The font size of the running text in the chapters is very large comparing to most website on the web. It looks like the font size is at 17pt
  • The H1 and H2 font size is currently also too large.
  • The font size of the left-side menu is good and should not be changed.

Should be:

  • The font size of the running text should be reduced, probably to around 12-14pt.
  • The font size of H1 and H2 should be reduced
  • The font of the left-side menu should not be changed.

Make the links between chapters and TOC relative

Currently, the links between the TOC and the chapters are hard-coded. When the repository is forked, all these links break.
Should be:
The links between the TOC and the chapters should work in forked repositories.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.