npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

docusaurus-portfolio-init

v1.0.2

Published

A package to initialize a new docusaurus-portfolio site.

Downloads

5

Readme

Docusaurus Portfolio Init


This is a Docusaurus website generator that provides support for docusaurus-portfolio on top of @docusaurus/init.

Usage

This package generates a website based on a default configuration specified in /templates.

To run the generator simply use the command:

npx docusaurus-portfolio-init init

Note: The CLI has three optional variables:

  1. siteName: the site name and directory of the project
  2. username: your GitHub username
  3. template: the template to be used

Using all options, your command might look like: npx docusaurus-portfolio-init init my-site porfolio-classic my-github.

Finally, start the project by navigating into the new directory and running.

cd <siteName>
yarn start

Templates

Currently this packages support two website templates.

portfolio-classic A robust portfolio website template that includes:

  • An introduction page with GitHub user and repository data.
  • An about me section with auto generated social-media icons.
  • A resume template with custom techinical skills pills.
  • A simple timeline page for more detailed personal information.
  • And Full blog support from docusaurus-blog.

Check out an example here.

authored-classic Generates a standard classic themed site using @docusaurus/init but adds an additional about me page.

Contributing:

More templates can be simply be added by adding a template directory in docusaurus-portfolio-init/templates and then updating the CLI (src/index.ts).