Socket
Socket
Sign inDemoInstall

create-webpage

Package Overview
Dependencies
121
Maintainers
2
Versions
13
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    create-webpage

VanillarJS Single Page Web Application Template Generator


Version published
Weekly downloads
1
Maintainers
2
Created
Weekly downloads
 

Readme

Source

create-webpage

npm init webpage, a web page generator.

Generate a webpage, using Q&A, package.json and README.md

Example

  • https://elements-x.github.io/create-webpage/sidebar
  • https://elements-x.github.io/create-webpage/scroll

How It Works

  1. Get basic information from Q&A
  2. Optionally, read your package.json and README.md
  3. Generate a static web app into the output directory

Usage

$ npm init webpage
? Project Name my webpage
? Description This is my single page application site.
? Choose a Template sidebar
Sidebar - A navigation menu on the left, contents on the right
Scroll - A long single page template navigation on the right
? Choose Appliaction Type static
Static HTML - No build required.
Javascript Applicatin - esbuild required from main.js
? Version 0.2.9
? Repo. URL https://github.com/elements-x/genpage
? Issue URL https://github.com/elements-x/genpage/issues
? License MIT
? Output Directory my-webpage
... processing message ...

To open the generated webpage

If static type, you can see the generated page by opening the output directory with a browser.

$ cd my-webpage && npx http-server -o

If js type, you can start your app

$ cd my-webpage
$ npm i
$ npm start

To set it as Github pages

A generated webpage is fully working as a SPA; Single Page Application. You can use it as your github page without any settings or modifiation.

To set your github page with your generated docs directory,

  1. Goto settings -> pages
  2. Select main branch, and set directory as '/docs', then `Save'. image

You can also generate a single file for any markdown file.

$ npm init webpage README.md 
$ npm init webpage README.md > docs/pages/readme.html # to update readme.html

FAQs

Last updated on 25 Nov 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc