Oral  Brekke

Oral Brekke

1620977220

The Goodness Of GitHub Pages, VuePress, and Markdown

Documentation is the most needed deliverable for any product or project. Sometimes, documentation is the deciding factor while choosing between two equally good frameworks/libraries in the open-source community.

Markdown played a major role in encouraging developers to do quick documentation without leaving their IDE. Importantly, Markdown fits well into the Git/source code control.

A new kind of documentation has started, which provides an interactive playground. Developers can explore the features of the product/components and can copy the code snippet. For example, check the following Vuetify component page

_Storybook _allows documenting your component using Markdown and JSX (MDX). Storybook’s inflexibility and mix-up of testing scope make it a second choice for documentation.

If you like the new generation documentation, but don’t have time to create the boilerplate code required, don’t worry. VuePress is there for your rescue.

Finally, you would prefer to host the static pages for everyone’s access. GitHub covers the base for you.

**Getting Started with GitHub Pages **— Reference

  • Create a new GitHub account (if required)
  • Create a new public repository named username.github.io, where username is your username (or organization name) on GitHub.

#vuepress #vuejs #markdown #github

What is GEEK

Buddha Community

The Goodness Of GitHub Pages, VuePress, and Markdown
Oral  Brekke

Oral Brekke

1620977220

The Goodness Of GitHub Pages, VuePress, and Markdown

Documentation is the most needed deliverable for any product or project. Sometimes, documentation is the deciding factor while choosing between two equally good frameworks/libraries in the open-source community.

Markdown played a major role in encouraging developers to do quick documentation without leaving their IDE. Importantly, Markdown fits well into the Git/source code control.

A new kind of documentation has started, which provides an interactive playground. Developers can explore the features of the product/components and can copy the code snippet. For example, check the following Vuetify component page

_Storybook _allows documenting your component using Markdown and JSX (MDX). Storybook’s inflexibility and mix-up of testing scope make it a second choice for documentation.

If you like the new generation documentation, but don’t have time to create the boilerplate code required, don’t worry. VuePress is there for your rescue.

Finally, you would prefer to host the static pages for everyone’s access. GitHub covers the base for you.

**Getting Started with GitHub Pages **— Reference

  • Create a new GitHub account (if required)
  • Create a new public repository named username.github.io, where username is your username (or organization name) on GitHub.

#vuepress #vuejs #markdown #github

A Simple Guide to Github Page Deployment

Long story short: Jekyll is a template engine changing

markdowndocuments on staticHTMLwebpages, that you can then host anywyere, because you don’t need databases or server that has PHP or Python.

Usual Process

Normally the process of adding new post looks like this:

  • I write markdown document with setting parameters like title, date and tags
  • when I’m happy with what I wrote (never), I commit changes and push it to repository on GitHub. Repository name comes from my nick and is also address for blog asvid.github.io
  • Github after pushing to branch master builds website from sources using Jekyll - probably something like running jekyll build
  • result of Jekyll build is not present in a repository, but you see it right now after visiting bloga page

#github-pages #github-page-with-jekyll #jekyll #github-actions #github #deployment #continuous-deployment #web-development

Arne  Denesik

Arne Denesik

1604199780

Convert Your Jupyter-notebook to Github pages with Github-action

As a data scientist and machine learning engineering, the Jupyter notebook is handy tools you can use.

How cool if you convert that notebook into a blog within less than 5 min?

And now this is possible with Github action and Fastpages templates.

You can find a live demo here.

1. Requirement

2. Step to follow

  • open Github account and use fastpages templates you can find a link here.

Image for post

  • Within 30 sec one pull request is generated by Github-action. Follow steps before you merge the pull request.

Image for post

  • Make sure you check this Allow write access.
  • Merge pull request and wait until Github-action makes Github pages.
  • Now you find a link in your Github repo readme file where you can find demo posts.

#github-pages #jupyter-notebook #github-actions #data-science #markdown

Oral  Brekke

Oral Brekke

1617437520

Deploying my portfolio website on Github Pages using Github Actions.

I recently deployed  my portfolio site and wanted to try out github actions and this is my experience of automating the deployment.

This article is more focused on how you can use the GitHub actions and how easy it is to deploy your code to GitHub pages rather than the portfolio site code.So every time you make an update or build to your website ,the changes are automatically reflected and this automated deploying process makes work much faster.

The way GitHub action works is you create actions in your repositories by creating one or more yaml files and these are called workflows.Workflows now can handle build tasks like CI CD. This means you use the action to test your code and push the site to the desired hosting platform (in this case GitHub pages ) when the main branch changes .

First step assuming that you have a GitHub account is to create a repository having your website code in it.Now I have a bootstrap website but in the future I do plan on adding node JS so I already added package.json.

#workflow #portfolio #github #github-actions #github-pages

Edison  Stark

Edison Stark

1603861600

How to Compare Multiple GitHub Projects with Our GitHub Stats tool

If you have project code hosted on GitHub, chances are you might be interested in checking some numbers and stats such as stars, commits and pull requests.

You might also want to compare some similar projects in terms of the above mentioned stats, for whatever reasons that interest you.

We have the right tool for you: the simple and easy-to-use little tool called GitHub Stats.

Let’s dive right in to what we can get out of it.

Getting started

This interactive tool is really easy to use. Follow the three steps below and you’ll get what you want in real-time:

1. Head to the GitHub repo of the tool

2. Enter as many projects as you need to check on

3. Hit the Update button beside each metric

In this article we are going to compare three most popular machine learning projects for you.

#github #tools #github-statistics-react #github-stats-tool #compare-github-projects #github-projects #software-development #programming