Markdown Profiles

About

Markdown Profiles is a project that generates markdown files for those that want an awesome Github profile.It provides several templates for you to use.

Table of contents

• Markdown Profiles
  • About
  • Table of contents
  • Prerequisites
  • Installation
  • Usage
    • Screenshots
    • Features
  • Code
    • Development
    • Build
    • Deploy
  • Contributing / Reporting issues
  • License

Prerequisites

In order to run the project the following requirements need to be met:

• Git
• NodeJS / npm

Installation

Clone the repository to your local machine and go into the folder:

git clone [email protected]:dannyverp/markdownprofile.git && \
cd markdownprofile

Download the vendor code using npm:

npm install

Usage

Screenshots

Features

Code

Development

To start developing please start the local development server:

npm run dev

Now open http://localhost:3000 and start creating cool content 🚀

Build

In order to build the project you can use NextJS's export functionality by running:

npm run export

This generates the HTML and Javascript files in the 'out' directory.

Deploy

The project is configured to be deployed to Github Pages by using Github Actions. The github action is set up to create a gh-pages branch which will contain the content of the out directory.

In order to deploy using this actions please set up a GITHUB_TOKEN in your project's secrets. Check out the Github Pages Action documentation.

Contributing / Reporting issues

Please check the contribution guide

License

Apache License, Version 2.0