Giter Club home page Giter Club logo

hackynote's Introduction

Welcome to HackyNote

Presentations made by Hackers

##HackyNote

What is that?

Is a markdown based presentation creator made for developers.

All that you need to do is access Hackynote starting writing markdown in the editor and instantly you will see your presentation being made.

####100% open-source and for fun HackyNote is all free for use, the goal is make it popular and recruit people to contribute to the project, push it fowards and make this app helps as much people as possible =D

####Clean Code I wrote HackyNote while i was reading Clean Code book from uncle book, so this application is all about quality of code. It's a try to implements as much good principles of code design as possible. This is the nature of HackyNote, it's more valuable to delivery a very well crafted refactoring thats makes the code cleaner than a bunch of new features that decrement the code quality.

Adding Themes & Transitions

  1. Fork this repository.

  2. Add your theme or transitions css to 'themes/[yourthemenamehere].css' or 'transitions/[yourthemenamehere].css'

  3. Add an entry to themes.json or 'transitions.json' with these properties:

    {
      "name": "My Theme",  // name of transition/theme ( will be displayied under the menu )
      "css": "themes/my_theme.css" // file of transition/theme ( will be loaded by the app )
      ]
    }
    
  4. Make sure that it looks alright by running ./scripts/web-server.js (requires Node.js)

  5. Send a pull request

Credits

HackyNote uses same outstanding libraries, created by real amazing people, and without these guys this project probably would never exists. Big thanks to everyone.

  • deck.js - The presentation engine
  • marked.js - The library that really does the dirty job of parsing the markdown
  • angular.js - Comments are useless
  • twitter bootstrap - Gives to the HackyNote a decent visual design =)

Copyright / License

Copyright 2013 Civilized Discourse Construction Kit, Inc.

Licensed under the GNU General Public License Version 2.0 (or later); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

hackynote's People

Contributors

thiagofelix avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.