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

@hestia-earth/guide

v0.0.10

Published

Hestia Guide pages

Downloads

1,059

Readme

Hestia Guide

This repository contains the raw content of the guide written in Markdown language.

Every file under src/content will be automatically deployed to https://hestia-earth.gitlab.io/hestia-guide domain for testing.

Example:

  • src/content/introduction.md will be deployed to https://hestia-earth.gitlab.io/hestia-guide/introduction
  • src/content/how-to-upload.md will be deployed to https://hestia-earth.gitlab.io/hestia-guide/how-to-upload

Note: only lower chars, dashes (-) and numbers are allowed in the filenames.

Writing Guidelines

  1. Create a new file under src/content and make sure the filename only uses lowercase letters, numbers and dashes.
  2. Start the file with a header level 2 using a double ##. Example:
## This is the header

This is the content.

### This is a sub-header

The header level 1 will be automatically used as Title for the Guide page, so please try to keep it short.

The second line (omitting the blank lines) will be used as abstract.

Important: the folder and the file name should reflect the Guide navigation structure.

Example: if you are adding a page called "Signing in" under "HESTIA 101", please add src/content/hestia-101/3_signin.md file. This will automatically:

  • show the page under "HESTIA 101" menu
  • show the page as item number 3 in the menu (if there are 2 pages before number 1_, 2_ in the same folder)
  • match the page with the url hestia-101-signin
  • the title of the page will be used also in the menu

Adding metadata

It is possible to add a list of metadata, using the following format:

/<name of metadata> ~Title~

These metadata must be added at the end of the file, one per line. The list of metadata is:

| Name | Can be added multiple times | Description | | ---- | ---- | ---- | | previous | ❌ | Link to the previous guide page (will show at the bottom) | | next | ❌ | Link to the next guide page (will show at the bottom) | | tag | ✅ | Used to group pages together as "related" |

Example:

# This is the title

This is the content of the page.

/tag ~Hestia~
/tag ~Beginners~
/previous ~how-to-upload~
/next ~how-to-access-data~

Adding images or videos

To add an image or a video to a page:

  • add the file under the src/assets folder. Note: you can use sub-directories to organise the files.
  • make sure to use a simple name, without special characters. So only letters and numbers, dashes or underscores.
  • in the content of the page, use either
    <img src="/guide-content/assets/<path to the file>" alt="Text to describe the image" height="auto">
    or to use videos in different formats
    <video width="320" height="240" controls>
      <source src="/guide-content/assets/<path to the file>.mp4" type="video/mp4">
      <source src="/guide-content/assets/<path to the file>.ogg" type="video/ogg">
    </video>