Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
ember-ted-docs
Advanced tools
Components for writing docs sites for your open-source projects at TED.
This is an Ember addon, so it assumes you'll be creating your docs site as an Ember app.
Documenting an Ember addon
You already have an Ember app under /tests/dummy
, so you can just use that for your docs site. There's also a great addon that makes it easy to deploy this app to GitHub Pages.
Documenting another project
You'll be making a new Ember app for your docs. Install Ember CLI if you haven't already. Then, from your project's repo, check out an orphaned branch and create an Ember appj
git checkout --orphan docs
git clean -fd # this removes the working files in your directory
ember init
and you're ready to go!
Install the following addons:
ember install ember-cli-sass
bower install --save bootstrap-sass
ember install ember-ted-docs
and import Bootstrap and TED docs' styles (you may need to rename app.css
to app.scss
:
<!-- tests/dummy/app/styles/app.scss -->
@import 'bower_components/bootstrap-sass/assets/stylesheets/bootstrap';
@import 'ember-ted-docs/styles';
Now ember s
and develop your docs using the components below.
In your template you can now use the <ted-page-header>
component:
{{ted-page-header
subheading='My'
slim-heading='Awesome'
strong-heading='Library'
byline='The best, most amazing thing to happen to anyone, anywhere'
github='http://github.com/tedconf/ember-ted-docs'}}
and here's what you get:
Now, go forth and document!
FAQs
The default blueprint for ember-cli addons.
We found that ember-ted-docs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.