Giter VIP home page Giter VIP logo

pippo.github.io's Introduction

Pippo site repository.

How to build

Requirements:

Steps:

  • create a local clone of this repository (with git clone https://github.com/decebals/pippo-site.git)
  • go to project's folder (with cd pippo-site)
  • make some modifications (see below sections)
  • test on your computer the modifications (see below sections)
  • commit and push the modifications on github

Install Jekyll

Create new page

We are using jekyll-docs-template to generate the site. This is a customized Jekyll project template optimized for flexible, multi-page documentation.

The template follows a very simple convention of defining categories that correspond to sections in the navigation. Here are the default ones (they are listed in the _config.yml):

  • doc - Documentation
  • ref - Reference
  • tut - Tutorial
  • dev - Developers
  • post - Posts

Since Jekyll is more geared towards blog posts, specifiying a date and setting up the front-matter can get tedious. Supplied in the bin directory is a simple Ruby scripy for creating a new page:

./bin/jekyll-page title category [filename] [--edit]

where title is the title of page, category is one of the categories defined in the _config.yml. By default the filename will be derived from the title, but you can specify an explicit filename (without the date) by passing the third agument. Finally the --edit (or just -e) will launch the editor defined by the $EDITOR environment variable.

Example:

./bin/jekyll-page "My New Page" ref

Will produce a file _posts/2013-06-05-my-new-page.md with the front-matter already defined:

---
layout: page
title: "My New Page"
category: ref
date: 2013-06-05 12:00:00
---

Simply add an order attribute to the front-matter of the page and the navigation links will be sorted accordingly (within it's section).

---
layout: page
title: "My New Page"
category: ref
date: 2013-06-05 12:00:00
order: 1
---

For convenience, a new directory will be created called _pages which contains symlinks to the posts without the data prefix, e.g. 2013-04-13-foo.md โ†’ foo.md. This makes it a tad easier when opening files to edit.

Edit page

Go to pages folder and edit the desired file with your favourite text editor.

Start the server

Start the server with: jekyll serve --watch
Open local site with: http://localhost:4000

Contributing

Any contribution is welcome. Please fork the repository and submit a Pull Request.

pippo.github.io's People

Contributors

balamaci avatar barrantesgerman avatar danielkutik avatar danjee avatar danstout avatar decebals avatar gitblit avatar munendrasn avatar rygel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

pippo.github.io's Issues

Use `pippo.GET(...)` instead of `pippo.getApplication().GET(...)`

For example:

public class HelloWorld {

    public static void main(String[] args) {
        Pippo pippo = new Pippo();
//        pippo.getApplication().GET("/", (routeContext) -> routeContext.send("Hello World!"));
       pippo.GET("/", (routeContext) -> routeContext.send("Hello World!")); // <<<
        pippo.start();
    }

}

Keep the documentation sync with pippo (a doc for each pippo version)

The problem:

  • I have multiple versions of pippo and I wish a public documentation for each pippo version

For example I wish to start to write the documentation for next pippo version but I don't know if I must create a new branch (for each pippo version a new doc branch) or we must go with readthedocs that supports this feature and more (for example I like the search - I think that it can be very useful).
I prefer a simple solution (I am happy to see that readthedocs supports markdown).

What you say?

Update Modularity section

The Initializer implementation was simplificated in last version. No need for pippo.properties file.
Now we use the Service Loader mechanism from Java (META-INF/services).
From version 0.9.0 you can use a simple annotation (see pippo-java/pippo#243).

Improve Server section

Specify that I can set manually a web server (to customize entirely the internal web server - jetty, tomcat, ... ) via Pippo.setServer().

Improve Server section

Update to PIppo 1.1.0 (fluent approach for set port and pippo filter in Pippo class, WebServer.addListener method is more generic now - you can add all listener types from Servlet's API).

Application.get()

Application.get() returns not null only in the context of web layer (on a http request). It cannot be useful in a service (server side business layer). For a service you must to inject PippoSettings in that service.

Add Parameters section

Write about parameters, path parameters and query parameters, about how I can read the parameter value.

Add README.md from modules (pippo) in documentation

Error in Guice section

To activate pippo-guice integration in your Application you must add GuiceControllerFactory:

public class MyApplication extends Application {

I think this should be

public class MyApplication extends ControllerApplication {

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.