docusaurus-portfolio-plugin v2.2.2-alpha.0

Docusaurus Portfolio Plugin

Installation:

yarn add docusaurus-portfolio-plugin

Note: this plugin will currently not function without also installing and configuring its sister package, docusaurus-portfolio-theme.

Configuration options:

To configure the plugin, add or update your configuration options in docusaurus.config.json. Listed below are the default options and descriptions of each field.

  plugins: [
    [
      'docusaurus-portfolio-plugin',
      {
        username: '<GITHUB-USERNAME>',                  // User's GitHub username
        path: 'me',                                     // Path in site where page will be served
        routeBasePath: 'me',
        pageTitle: 'About Me',
        pageDescription: 'My GitHub Repos',
        portfolioPageComponent: '@theme/PortfolioPage',
        userOptions: {
          fullname: '',                                 // Name to be displayed in usercard
          links: [],                                    // UNIMPLEMENTED: Links to be displayed in usercard
        },
        repoOptions: {
            type: '',                                   // Type of repos to be queried
                                                        // ['all','public','private','forks','sources','member','internal']
            sort: '',                                   // Field to sort repos using
                                                        // ['created','updated','pushed','full_name','size','stargazers_count','watchers_count','forks_count',]
            direction: '',                              // Direction repos will be sorted in
                                                        // ['asc','desc']
            numRepos: Number.MAX_VALUE                  // Number of repos. Default: all.
        }
      },
    ],
  ],

Important: if otherwise not configured, options will be left to GitHub API defaults.