Skip to content

Commit

Permalink
docs: add jekyll site with first pages
Browse files Browse the repository at this point in the history
  • Loading branch information
lgdd committed Apr 29, 2024
1 parent 67c466a commit 8b49911
Show file tree
Hide file tree
Showing 18 changed files with 678 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_site
.sass-cache
.jekyll-cache
.jekyll-metadata
vendor
26 changes: 26 additions & 0 deletions docs/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
permalink: /404.html
layout: default
---

<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
}

h1 {
margin: 30px 0;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>

<div class="container">
<h1>404</h1>

<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>
19 changes: 19 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
source "https://rubygems.org"

gem "jekyll", "~> 4.3.3"
gem "minima", "~> 2.5"

group :jekyll_plugins do
gem "jekyll-feed", "~> 0.12"
end

platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", ">= 1", "< 3"
gem "tzinfo-data"
end

gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

gem "just-the-docs"
104 changes: 104 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.6)
public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
concurrent-ruby (1.2.3)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.16.3)
forwardable-extended (2.6.0)
google-protobuf (3.25.3)
google-protobuf (3.25.3-arm64-darwin)
google-protobuf (3.25.3-x86_64-darwin)
google-protobuf (3.25.3-x86_64-linux)
http_parser.rb (0.8.0)
i18n (1.14.4)
concurrent-ruby (~> 1.0)
jekyll (4.3.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (>= 2.0, < 4.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3, >= 2.3.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (>= 0.3.6, < 0.5)
pathutil (~> 0.9)
rouge (>= 3.0, < 5.0)
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-feed (0.17.0)
jekyll (>= 3.7, < 5.0)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
just-the-docs (0.8.2)
jekyll (>= 3.8.5)
jekyll-include-cache
jekyll-seo-tag (>= 2.0)
rake (>= 12.3.1)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.5)
rake (13.2.1)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.6)
rouge (4.2.1)
safe_yaml (1.0.5)
sass-embedded (1.69.5)
google-protobuf (~> 3.23)
rake (>= 13.0.0)
sass-embedded (1.69.5-arm64-darwin)
google-protobuf (~> 3.23)
sass-embedded (1.69.5-x86_64-darwin)
google-protobuf (~> 3.23)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.5.0)
webrick (1.8.1)

PLATFORMS
arm64-darwin
ruby
x86_64-darwin
x86_64-linux

DEPENDENCIES
http_parser.rb (~> 0.6.0)
jekyll (~> 4.3.3)
jekyll-feed (~> 0.12)
just-the-docs
minima (~> 2.5)
tzinfo (>= 1, < 3)
tzinfo-data
wdm (~> 0.1.1)

BUNDLED WITH
2.5.9
60 changes: 60 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.

title: lfr-cli
description: >- # this means to ignore newlines until "baseurl:"
lfr is an unofficial CLI tool written in Go that helps you create & manage Liferay projects.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
twitter_username: jekyllrb
github_username: jekyll

# Build settings
theme: just-the-docs
color_scheme: light
aux_links:
"On GitHub":
- "//github.com/lgdd/lfr-cli"
aux_links_new_tab: true
back_to_top: true
back_to_top_text: "Back to top"

plugins:
- jekyll-feed

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
exclude:
- .sass-cache/
- .jekyll-cache/
- gemfiles/
- Gemfile
- Gemfile.lock
- node_modules/
- vendor/bundle/
- vendor/cache/
- vendor/gems/
- vendor/ruby/
28 changes: 28 additions & 0 deletions docs/commands/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
layout: default
title: lfr build
parent: Commands
nav_order: 3
permalink: /commands/build
---

# lfr build

It allows you to build your Liferay Workspace. It works as a shortcut for the corresponding Gradle or Maven goal, i.e. `./gradlew clean install` or `./mvnw clean install`.

If you go in a subdirectory, it will only build the artifacts the subdirectory contains.

## Usage:
```shell
lfr build [flags]
# or
lfr b
```

## Flags:
- `-h`, `--help`
- help for `lfr init`

## Global Flags:
- `--no-color`
- disable colors for output messages
11 changes: 11 additions & 0 deletions docs/commands/commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
layout: default
title: Commands
nav_order: 4
has_children: true
permalink: /commands
---

# Commands

The list is not exhaustive. The documentation is still a work in progress.
47 changes: 47 additions & 0 deletions docs/commands/create/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: default
title: lfr create
parent: Commands
nav_order: 2
has_children: true
permalink: /commands/create
---

# lfr create

It allows you to create many types of components: Liferay Workspace, Client Extensions, Docker (Dockerfile & docker-compose.yml) and OSGi components (API, Gogo Shell Command, MVC Portlet, Spring Portlet, REST Builder & Service Builder).

## Usage:
```shell
lfr create TYPE NAME [flags]
# or
lfr c TYPE NAME [flags]
```

Running this command with no argument triggers the interactive mode where you can choose the template and enter a name from the terminal (and other options depending on the template). To make the interactive mode accessible, edit `/.lfr/config.toml`:

```toml
[output]
accessible = true
```

## Available Commands:
- `lfr create workspace`
- `lfr create client-extension`
- `lfr create docker`
- `lfr create api`
- `lfr create command`
- `lfr create mvc-portlet`
- `lfr create spring-mvc-portlet`
- `lfr create rest-builder`
- `lfr create service-builder`

## Flags:
- `-h`, `--help`
- help for `lfr create`
- `-p`, `--package string`
- base package name (default "org.acme")

## Global Flags:
- `--no-color`
- disable colors for output messages
50 changes: 50 additions & 0 deletions docs/commands/create/create_client_extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
layout: default
title: lfr create client-extension
grand_parent: Commands
parent: lfr create
nav_order: 2
permalink: /commands/create/client-extension
---

# lfr create client-extension

It allows you to create a Client Extension from an official sample. Since Client Extensions are under intensive development, they're not available as templates. So you will need to update the configuration files of any Client Extension you create.


The configuration directory contains the Client Extensions samples. The samples are cloned from a [custom repository](https://github.com/lgdd/liferay-client-extensions-samples){:target="_blank"} that mirrors the [official samples contained in the monorepo](https://github.com/liferay/liferay-portal/tree/master/workspaces/liferay-sample-workspace/client-extensions){:target="_blank"} and rename some components to be more intelligible.

## Usage:
```shell
lfr create workspace NAME [flags]
# or
lfr c ws NAME [flags]
```

Running this command with no argument triggers the interactive mode where you can choose the template and enter a name from the terminal (and other options depending on the template). To make the interactive mode accessible, edit the `/.lfr/config.toml`:

```toml
[output]
accessible = true
```

## Examples:
```shell
lfr c cx batch my-batch
lfr c cx custom-element-angular my-angular
lfr c cx custom-element-react-dom my-react
lfr c cx etc-node my-node-microservice
lfr c cx etc-spring-boot my-spring-boot-microservice
lfr c cx site-initializer my-site-initializer
lfr c cx commerce-payment-integration my-payment-connector
```

## Flags:
- `-h`, `--help`
- help for `lfr create`

## Global Flags:
- `--no-color`
- disable colors for output messages
- `-p`, `--package string`
- base package name (default "org.acme")
Loading

0 comments on commit 8b49911

Please sign in to comment.