npmpackage.info

Gathering detailed insights and metrics for guidemaker

Other packages similar to guidemaker

guidemaker-ember-template

4.1.0

Guidemaker template for Ember Guides websites

guidemaker-default-template

7.0.0

The default blueprint for ember-cli addons.

guidemaker-toc-checker

1.0.0

Mocha based testing system for checking guidemaker table of contents

guidemaker-link-checker

1.0.1

Mocha based testing system for guidemaker source files

Gathering detailed insights and metrics for guidemaker

guidemaker - 4.0.4 | npmpackage.info

guidemaker

A fully-functional, static site implementation of a documentation site and is built on EmberJS and using Empress technologies

4.0.4

MIT

JavaScript

58.37 kB

3.4

Installations

npm install guidemaker

Developer Guide

BETA

Typescript

No

Module System

N/A

Min. Node Version

>= 18

Node Version

18.20.5

NPM Version

10.8.2 Pull Requests

Open

7

Total

105

Closed

33

Merged

65

Issues

Open

8

Total

13

Closed

5

Releases

v4.0.4-guidemaker

Updated on Dec 17, 2024

v4.0.3-guidemaker

Updated on Jun 25, 2024

v4.0.2-guidemaker

Updated on May 03, 2024

v4.0.1-guidemaker

Updated on Mar 08, 2024

v4.0.0-guidemaker

Updated on Mar 08, 2024

v3.3.1-guidemaker

Updated on Dec 18, 2023

View All 29 releases

Languages

JavaScript

HTML

CSS

JavaScript (96.42%)

HTML (3.42%)

CSS (0.16%)

Developer

empress

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

24 Stars

333 Commits

16 Forks

7 Watchers

9 Branches

13 Contributors

Updated on Mar 17, 2025

Maintainers

View All 13 Contributors

Package Meta Information

Latest Version

4.0.4

Package Id

guidemaker@4.0.4

Unpacked Size

58.37 kB

Size

18.67 kB

File Count

NPM Version

10.8.2

Node Version

18.20.5

Published on

Dec 17, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

@ember-data/adapter @ember-data/model @ember-data/serializer ember-source showdown

Dev Dependencies

guidemaker

This project is designed to be a fully-functional, static site implementation of a documentation site and is built on EmberJS with fully working out of the box SEO friendly output. It supports being hosted on AWS S3 or any other static site hosting solution.

This system is designed to have a core functionality provided by this repository/package and seperate packages that provide the themes and styling to your Documentation site.

Guidemaker Default Template is a basic theme that is intended to provide a default style for new projects.
Guidemaker Ember Template is the official theme used for all Ember Learning Core Team projects

If you are interested in writing your own theme for Guidemaker please reach out to us and we can walk you through the process. Hopefully if there is enough interest we can provide basic instructions on how to build your own theme using this system.

If you want an example of the this "in production" then check out the Ember Guides. If you use this in production let us know on Twitter and we can add a "built with guidemaker" wiki.

You do not need to be a web developer to be able to use this system. You just write markdown files and the rest of the work is performed by the EmberJS build system.

Compatibility

Ember.js v3.28 or above
Ember CLI v3.28 or above
Node.js v18 or above

Super Quick Start

If you want to start writing your documentation right away and want to deploy your new Guidemaker documentation site on Netlify in less than a minute then you can just click this button:

This will create a new repo in your GitHub account that has everything setup and ready to go, as well as setting up Netifly to do Continuous Deployment of your new documentation site.

If you want to instead work with your documentation site locally before deploying then you can continue reading

Quick Start

1# if you don't have ember-cli installed already
2npm install -g ember-cli
3
4ember new super-docs
5cd super-docs
6
7ember install guidemaker guidemaker-default-template

It will ask you if you want to update the index.html file and you should say yes 👍

To build the static output directory, run the standard build process for a production Ember application:

1ember build -e production

This will generate a fully static output of your site in the dist folder.

If you want to see the system running on your local machine just run npm start and you will be able to navigate to http://localhost:4200 to see the documentation site in action.

Configuration

After you install Guidemaker using the instructions above, you will see that your config/environment.js file will have been edited to add a guidemaker config object. You should update this with the details relevant to your documentation.

Here is an example config with comments to explain the use of each of the attributes:

1guidemaker: {
2  // This title will be used in place of a logo if you do not provide one
3  title: 'Guidemaker docs',
4  // This logo will be used in the top left of the page - you can add it to your public folder
5  logo: '/images/logo.svg',
6  // this will be used for the copyright line in the bottom left of the page - if not provided then
7  // it will use `title` instead
8  copyright: 'My Awesome Company',
9  // show social links
10  social: {
11    // provide the slug for the github link (can be a project or an org)
12    github: 'empress/guidemaker',
13    // provide your username
14    twitter: 'real_ate',
15    // provide your invite link for your public discord
16    // discordLink: '<insert link here>'
17  },
18  // this should be the link to your documentation source - if you provide one it will add an edit button on each page
19  // sourceRepo: 'https://github.com/authmaker/documentation',
20
21  // this allows you to override the branch that is used in the edit button (if you have provided a sourceRepo). It is up to the templates, but most of them default to master if you don't provide this setting
22  // sourceBranch: 'master'
23
24  // when true the Table of Contents will be collapsed and you will need to click each header to expand
25  // default - false
26  collapseToc: true,
27}

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:111: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:115: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:125: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/plan-release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/plan-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/plan-release.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/plan-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/plan-release.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/plan-release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/plan-release.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/plan-release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/plan-release.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/plan-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/publish.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/empress/guidemaker/publish.yml/main?enable=pin
Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 8 third-party GitHubAction dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.4

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More