Skip to content

Commit

Permalink
Initial commit from fork, light version with only Compodoc
Browse files Browse the repository at this point in the history
  • Loading branch information
vogloblinsky committed Jan 29, 2019
1 parent 6b6c11e commit ec7ce07
Show file tree
Hide file tree
Showing 62 changed files with 9,747 additions and 3 deletions.
25 changes: 25 additions & 0 deletions .gitignore
@@ -0,0 +1,25 @@
dist/
www/

*~
*.sw[mnpcod]
*.log
*.lock
*.tmp
*.tmp.*
log.txt
*.sublime-project
*.sublime-workspace

.idea/
.vscode/
.sass-cache/
.versions/
node_modules/
$RECYCLE.BIN/

.DS_Store
Thumbs.db
UserInterfaceState.xcuserstate
.env
documentation
18 changes: 18 additions & 0 deletions .travis.yml
@@ -0,0 +1,18 @@
language: node_js
branches:
only:
- master
node_js:
- '9'
cache:
directories:
- node_modules
install:
- npm install
script:
- npm run doc
- bash ./deploy.sh
env:
global:
- GH_REF: github.com/compodoc/compodoc-demo-stencil.git
- secure: x92HdNuE8vJptQKNrV7fNnASsP18K4XJExV3LZ0/zuy9Dp0n5aES7XwBOf/41ukKZz1fLNNh3eIh8XqON9hbThCaaM+bCipXHYTKHyKpZpoMRNqUn2ukeXgAuAN3gOOEBP8jM71XAfJTPwIuOuRCrEgAf/a1d8oXWYoDOuq7YTQvgnSEt3LAjDmeimeTM8o6F3j9b95z6Ha1spxLNUS6dndGMCApC48vTGgFDR8keEtm3WeAMZrkQzPcaS3BLm29V4WzhPXe6quuj7l94ct1vGXuMVp+3tqZd7DdRxqzfsmapHYQuU+a6A1oa3nTs0X07wmF+8OBCCUf5yuaZEs34Dzs9wjgoEt29JT2c/mDuPTVrvVtxu8LKN7bSXchPPV9+FtraRWTWmpwr+bnRr/wQm3R6fG4LohVQ5me83jehwvT3FnmJJb9Gh3HpluCeRKeSJ1WtenvFJlqvGNgFRipHX+1xtAex6/v5gJ4VVDantdZfaHYQVouU/q+IF1WIOhQSlkKLoWQY19YBnDEYJjJSSiskEgIBMJeONFPezU5qsasPZNwWLkVtQAHy7cO+Y8WEAoiwR5E1/WwqDwCX0oIuBn0dYwiagP68Z4x45r1tFlYIwziK/CqyPY/oRXPiklJ/RlbL7vB0DS6YZKTq5BNyKFvM1rKWiRrvNyvVtFLUEQ=
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2019 Compodoc
Copyright (c) 2017 Ionic

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
22 changes: 20 additions & 2 deletions README.md
@@ -1,2 +1,20 @@
# compodoc-demo-stencil
Stencil demo application documented, and ready for Compodoc
# Compodoc Demo Stencil

[Live demo](https://compodoc.github.io/compodoc-demo-stencil/)

This project was forked from https://github.com/jgw96/stencil-beer

It is a demo project for demonstrating Compodoc features :

- architecture
- components documentation
- documentating methods and properties of components, classes, interfaces, etc...

## Getting Started

To build the documentation, run:

```bash
npm i
npm run doc
```
19 changes: 19 additions & 0 deletions deploy.sh
@@ -0,0 +1,19 @@
#!/usr/bin/env bash
echo "Starting deployment"
echo "Target: gh-pages branch"

GIT_DEPLOY_REPO=${GIT_DEPLOY_REPO:-$(node -p -e "require('./package.json').repository.url")}

cd documentation && \

rm -R .git
git init && \

echo "Pushing new content to $ORIGIN_URL"
git config user.name "Travis CI" && \
git config user.email "github@travis-ci.org" && \

git add . && \
git commit -m "Deploy to GitHub Pages" && \

git push --force "https://${GH_TOKEN}@${GH_REF}" master:gh-pages > /dev/null 2>&1

0 comments on commit ec7ce07

Please sign in to comment.