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

angular-pages

v0.1.1

Published

Build an Angular app from a directory of HTML or Markdown files

Downloads

3

Readme

Angular Pages

The static site generator that lets you mix Markdown, HTML, and Angular Components! Write your HTML or Markdown files and Angular Components with Routes will be generated to mimic the structure of those files in the ./pages directory of your Angular Project.

Install Angular Pages into an NG CLI generated Angular App

Prequisites:

  • Node 8 (nodejs.org)

In the future we'll have an angular-page init command. For now, set up is manual.

  • Run npm install -g angular-pages gh-markdown-cli angular-cli.
  • If you haven't generated your project yet, run ng new my-new-project && cd my-new-project.
  • create a pages directory at ./pages.
  • Run angular-pages build (always run in the root directory of your Angular project)
  • ES6 and Angular import the PagesRouterModule at ./src/pages/pages-routing.module.ts into ./src/app/app.module.ts

Optional:

  • In your package.json, add angular-pages build && to npm build.
  • Add the angular-pages build --watch & ng serve to npm start
  • Set imports: [RouterModule.forRoot(routes, { useHash: true })], in app-routing.module.ts if you are using a static server like Github Pages. This will make sure URLs are formed like foo.com/#/my-angular-route/ as opposed to foo.com/my-angular-route. If you did not set useHash to true and a user hits reload in their browser on foo.com/my-angular-route, that will cause the browser to ask the static server for foo.com/my-angular-route/index.html because of how static web servers work.
  • Create a ./pages/index.md file to create a root path.

Write your pages

  • Put any HTML or Mardown files in the ./pages directory, run angular-pages build the script will create a Component and Route for that page in your Angular App. For example, if you had a Markdown page at ./pages/some-path/hello-world.md, you would then see the rendered HTML when you go to the /some-path/hello-world in your app.

You might not need Angular Pages if...

  • You just need a static site where you can define arbitrary page stucture with a series of Markdown files but you don't need Angular Components on those pages. Use mdWiki! It's brilliant.
  • You need RSS feeds for a blog.