🥳 Amazing! You created your project from the template.
Your input variables defined in .ftsettings.json
for the template:
Key | Default | Transform |
---|---|---|
Company | KargWare | pascalcase |
Project | NewPlugIn | pascalcase |
ProjectName | jekyll-kw-newplugin | lowercase paramcase |
Transformations (combine them with ?
)
- Company :
KargWare
➔ KargWare - Project :
LoremIpsum
➔ LoremIpsum - ProjectName :
jekyll-kw-LoremIpsum
➔ jekyll-kw-loremipsum
The namespace of the project jekyll-kw-loremipsum
is Jekyll::KargWare::LoremIpsum
module Jekyll
module KargWare
module LoremIpsum
...
end
end
end
- Check the content of
[.gitignore](.gitignore)
file - Delete not needed files and folders from root folder
STEPS.md
README.md
docu-img/
.fttemplates/Create RubyGem project structure/
- Do the
initial commit
to the project - Install dependencies
bundle install
- Run tests
bundle exec rake test
- Create documentation
bundle exec rake rdoc
- Observe the documentation (via docker) on localhost:8099
docker run -d --rm -p 8099:80 --name rdoc-jekyll-kw -v $(pwd)/rdoc:/usr/local/apache2/htdocs/ httpd:alpine
TODO: NextSteps.md -> Step 1
TODO: NextSteps.md -> Step 2
TODO: NextSteps.md -> Step 3