docusaurus-portfolio

A Docusaurus v2 plugin that generates a portfolio page from Github.

---

For a blog-style introduction to Docusaurus plugin development and docusaurus-portfolio, check out my blog.

Introduction

docusaurus-portfolio is a set of packages designed for Docusaurus that allow users to display a stripped-down version of their Github page on their documentation website. It also includes includes an initialization script that generates a full portfolio website with an about me, resume page, timeline, and blog.

Check out my site for an example: https://silva-nick.github.io/portfolio/

Usage

The fastest way to get started with docusaurus-portfolio is to initialize a package through docusaurus-portfolio-init. To run the generator simply replace the blanks and run the command:

npx docusaurus-portfolio-init init <SITE-NAME> portfolio-classic <GITHUB-USERNAME>

Then, to start your app run

cd <SITE-NAME>
yarn start

For more information on generating a website with docusaurus-portfolio-init check out its documentation page.

Packages

This project uses Lerna to manage all packages. Each package has specific documentation in its respective directory.

docusaurus-portfolio-init

Docusaurus website generator built off of @docusaurus/init.

docusaurus-portfolio-plugin

The main Docusaurus portfolio plugin that manages the GitHub API requests.

docusaurus-portfolio-theme

The React.js components that drive docusaurus-portfolio.

Contributing

Contributions are always welcome!

Ways to contribute:

• Found a bug or want to request a new feature: Open an Issue
• Is the documentation confusing: Open a pull request on the documentation site or README.md
• Want to add any code: Open a PR
• Looking for other ways: Try adding docusaurus-portfolio to your website