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

hygen-docusaurus

v1.1.0

Published

A hygen package for Docusaurus

Downloads

6

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

kgajerakgajera

Keywords

hygengeneratorboilerplatedocusaurus

Readme

hygen-docusaurus

A Hygen package for Docusaurus that supercharges your workflow.

Getting Started

Install hygen-add:

npm i -g hygen-add

And add the hygen-docusaurus package:

hygen-add docusaurus

Generators

Blog Post

Creates a blog/YYYY-MM-DD-name/index.md file for the blog content plugin:

hygen blog new [name]

| Argument | Type | Description | | -------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [name] | string | Name of blog post (my-blog-post) | | --authors | string | Comma separated list of blog post authors. | | --title | string | The blog post title. | | --tags | string | Comma separated list of tags. | | --draft | boolean | A boolean flag to indicate that the blog post is work-in-progress and therefore should not be published yet. However, draft blog posts will be displayed during development. | | --hide_table_of_contents | boolean | Whether to hide the table of contents to the right. | | --toc_min_heading_level | number | The minimum heading level shown in the table of contents. Must be between 2 and 6 and lower or equal to the max value. | | --toc_max_heading_level | number | The max heading level shown in the table of contents. Must be between 2 and 6. | | --keywords | string | Keywords meta tag, which will become the <meta name="keywords" content="keyword1,keyword2,..."/> in <head>, used by search engines. | | --description | string | The description of your document, which will become the <meta name="description" content="..."/> and <meta property="og:description" content="..."/> in <head>, used by search engines. | | --image | string | Cover or thumbnail image that will be used when displaying the link to your post. | | --slug | string | Allows to customize the blog post url. | | -i | boolean | Run the generator in interactive mode to prompt for all arguments. |

Component

Creates a React component in the src/components directory:

hygen component new [name]

| Argument | Type | Description | | -------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [name] | string | Name of component (MyButton). |

Doc

Creates a markdown file in the docs directory for the docs content plugin:

hygen doc new [name]

| Argument | Type | Description | | -------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [name] | string | Support multiple patterns: getting-started, /my/path/to/getting-started. | | --id | string | A unique document id. | | --title | string | The text title of your document. | | --pagination_label | string | The text used in the document next/previous buttons for this document. | | --sidebar_label | string | The text shown in the document sidebar for this document. | | --sidebar_position | number | Controls the position of a doc inside the generated sidebar slice when using autogenerated sidebar items. See also Autogenerated sidebar metadata. | | --sidebar_class_name | string | Gives the corresponding sidebar label a special class name when using autogenerated sidebars. | | --hide_title | boolean | Whether to hide the title at the top of the doc. It only hides a title declared through the front matter, and have no effect on a Markdown title at the top of your document. | | --hide_table_of_contents | boolean | Whether to hide the table of contents to the right. | | --toc_min_heading_level | number | The minimum heading level shown in the table of contents. Must be between 2 and 6 and lower or equal to the max value. | | --toc_max_heading_level | number | The max heading level shown in the table of contents. Must be between 2 and 6. | | --pagination_next | string | The ID of the documentation you want the "Next" pagination to link to. Use null to disable showing "Next" for this page. | | --pagination_prev | string | The ID of the documentation you want the "Previous" pagination to link to. Use null to disable showing "Previous" for this page. | | --keywords | string | Keywords meta tag for the document page, for search engines. | | --description | string | The description of your document, which will become the <meta name="description" content="..."/> and <meta property="og:description" content="..."/> in <head>, used by search engines. | | --image | string | Cover or thumbnail image that will be used when displaying the link to your post. | | --slug | string | Allows to customize the document url. | | --tags | string | Comma separated list to tag to your docs. | | -i | boolean | Run the generator in interactive mode to prompt for all arguments. |

Page

Creates a React component in the src/pages directory:

hygen page new [name]

| Argument | Type | Description | | -------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [name] | string | Name of component (Home).