Code Monkey home page Code Monkey logo

science-blog-template's Introduction

Science and Technology Blog template

Installation instructions

  1. Install Jekyll: The instructions are given in post
  2. Edit _config.yml file:
    • Change baseurl to your folder name.
    • Change the respective URLs and variable names.
    • If you want to enable disqus comments, change dqs_shortname to your forum's disqus_shortname. Otherwise, turn comments to false.
  3. You might want to change the URLs in _includes/link.html file.

Now your science and technology blog is up and running. Happy blogging!

Notes

  • Make sure you commit changes to the branch from which github pages are published.
  • I have only tested this repository on Ubuntu 16.04. If everything doesn't work smoothly, you'll probably have to look it up.

About

This is a simple template for creating a Science and Technology Blog.

The code base is inspired from Emerald repository.

The template contain following features:

Jekyll-based website

  • This code-base is meant to host on github pages.
  • Github pages uses Jekyll that can convert your markdown pages into beautiful looking blog pages without needing to write cumbersome HTML code.
  • Once you set up the site, blogging becomes as fast as using any online service such as Wordpress, Blogger, etc.

Free website publishing with Github-pages

  • Since Github public repositories are free, you do not need to pay a cent to anyone for publishing your blog.

Commenting with Disqus

  • The template has included Disqus comments. So, if enabled, your readers can comment on any of your posts.
  • This also makes sharing your writings on social platforms easy.
  • Disqus basic account is for free and avails you with most of its features.

Latex rendering

  • If you have a scientific mind and you do not shy away from equations, the website is MathJax enabled. You can simply type your math equations in Latex format.

Code

  • You can also demonstrate your code in code blocks.

Contribution

If you want to contribute to the repository to improve the code, feel free to submit a pull request.

science-blog-template's People

Contributors

pranjaldhole avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

science-blog-template's Issues

Accessibility errors found in your template

The user @carlsonsantana validate your site template "https://pranjaldhole.github.io/science-blog-template/" and found these accessibility errors:

  • Page https://pranjaldhole.github.io/science-blog-template/:
    • Issue accb2273-4ad2-41dd-b020-dc908becab68:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_3.1_3_1.F92,ARIA4
      • Message: This element's role is "presentation" but contains child elements with semantic meaning.
      • Selector: #MathJax-Element-1-Frame > span:nth-child(2)
      • Context: <span class="MJX_Assistive_MathML MJX_Assistive_MathML_Block" role="presentation"><math xmlns="http://www.w3.org/...</span>
    • Issue 353c8298-7779-4e7f-bd2b-aba377deacc1:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_3.1_3_1.F92,ARIA4
      • Message: This element's role is "presentation" but contains child elements with semantic meaning.
      • Selector: #MathJax-Element-1-Frame
      • Context: <span id="MathJax-Element-1-Frame" class="mjx-chtml MathJax_CHTML" tabindex="0" data-mathml="<math xmlns=&quot;http://www.w3.org/1998/Math/MathML&quot; display=&quot;block&quot;><mfrac><mrow class=&quot;MJX-TeXAtom-ORD&quot;><mi mathvariant=&quot;nor...
    • Issue fef6a86f-8221-4ea4-a2ee-9d19e74d44ed:
      • Type: Error
      • Code: WCAG2AA.Principle1.Guideline1_1.1_1_1.H37
      • Message: Img element missing an alt attribute. Use the alt attribute to specify a short text alternative.
      • Selector: #wrap > footer > span > p:nth-child(1) > img
      • Context: <img src="/science-blog-template/img/logo.svg" style="vertical-align:middle" width="30" height="30">
    • Issue 0f26af8b-2448-4ec5-b5db-77486553aed8:
      • Type: Error
      • Code: WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.A.NoContent
      • Message: Anchor element found with a valid href attribute, but no link content has been supplied.
      • Selector: #nav-menu
      • Context: `
        `
    • Issue c5c6b28a-0b7c-4b93-8d45-70a7c28750c1:
      • Type: Error
      • Code: WCAG2AA.Principle3.Guideline3_1.3_1_1.H57.2
      • Message: The html element should have a lang or xml:lang attribute which describes the language of the document.
      • Selector: html
      • Context: `
      <meta ch...`

You can check these accessibility errors using pa11y.
You can view the full validation results in our website.

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.