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

@swimlane/docspa-core

v8.0.3

Published

> An Angular-powered documentation SPA.

Downloads

63

Readme

DocSPA

An Angular-powered documentation SPA.

Introduction

DocSPA (like it's inspiration docsify) generates your documentation website on the fly. Unlike GitBook, it does not generate static HTML files. Instead, it loads and parses your Markdown files and displays them as website. Unlike docsify, DocSPA generates an Angular SPA, which allows embedded Angular components and excellent custom element support.

See the Quick start for details on how to get up and running quickly.

How it works

A DocSPA site is a SPA powered by Angular and the Angular CLI. If you've used the Angular CLI before you already know a lot about the DocSPA infrastructure. If you built Angular applications before, customizing a DocSPA site will be a familiar experience. If you are not familiar with Angular, no worries, out-of-the-box DocSPA provides a simple experience so you can get right to your content.

As mentioned DocSPA is a Angular SPA. It uses Angular CLI tools for the build process. Once built and deployed the DocSPA site will generate HTML content on-the-fly from your markdown content. Markdown files are converted to HTML using (remark)[https://remark.js.org/]. Remark plugins (both DocSPA internal and third-party) handle all markdown extensions. In addition, the DocSPA site supports custom elements (one of the key features of the Web Components standard) and includes custom elements that allows live Angular examples within markdown!

Features

Examples

Todo

DocSPA is a work in progress. DocSPA was developed by Swimlane for use in Swimlane projects.

Why not X?

DocSPA is not SEO-friendly, if you need a pregenerate SEO-friendly site without live Angular support you might try GitBook. If you don't need a pregenerate site nor embedded Angular code (or prefer Vue) you might try Docsify.

Credits

DocSPA is a Swimlane open-source project; we believe in giving back to the open-source community by sharing some of the projects we build for our application. Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.

DocSPA was developed in Angular following inspiration from docsify by QingWei-Li and contributors.