initial commit with configs and scripts
This commit is contained in:
Diego Carrasco G
parent
8cbc458eda
commit
f4f579f52a
119
README.md
119
README.md
@ -1,93 +1,88 @@
|
||||
# Proxmox Book
|
||||
|
||||
## How to
|
||||
|
||||
### Generate PDF with basic theme
|
||||
|
||||
## Getting started
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
|
||||
## Add your files
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://gitlab.com/practical-books/proxmox-book.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```bash
|
||||
docker run -v $PWD:/src asciidoctor/docker-asciidoctor /usr/bin/asciidoctor-pdf\
|
||||
/src/output2.adoc \
|
||||
-a pdf-theme=/src/theme/basic-theme.yml \
|
||||
-D /src/output
|
||||
```
|
||||
|
||||
## Integrate with your tools
|
||||
### Generate PDF with diagrams
|
||||
|
||||
- [ ] [Set up project integrations](https://gitlab.com/practical-books/proxmox-book/-/settings/integrations)
|
||||
```bash
|
||||
sudo docker run -v $PWD:/src asciidoctor/docker-asciidoctor /usr/bin/asciidoctor-pdf -r asciidoctor-diagram /src/mkt.adoc -a
|
||||
pdf-theme=/src/theme/basic-theme.yml -D /src/output
|
||||
```
|
||||
|
||||
## Collaborate with your team
|
||||
### Generate DOCX
|
||||
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
```bash
|
||||
INPUT_ADOC=mkt.adoc
|
||||
asciidoctor --backend docbook --out-file - $INPUT_ADOC| \
|
||||
pandoc --from docbook --to docx --output $INPUT_ADOC.docx
|
||||
|
||||
## Test and Deploy
|
||||
# On the Mac, this will open the generated file in MS Word
|
||||
open $INPUT_ADOC.docx
|
||||
```
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
```bash
|
||||
INPUT_ADOC=mkt.adoc
|
||||
sudo docker run -v $PWD:/src asciidoctor/docker-asciidoctor -r asciidoctor-diagram /usr/bin/asciidoctor-pdf --backend docbook --out-file - $INPUT_ADOC| \
|
||||
pandoc --from docbook --to docx --output $INPUT_ADOC.docx
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
# On the Mac, this will open the generated file in MS Word
|
||||
open $INPUT_ADOC.docx
|
||||
```
|
||||
|
||||
***
|
||||
|
||||
# Editing this README
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
## Convert html to images
|
||||
|
||||
## Suggestions for a good README
|
||||
This are some custom scripts to create and embed Images from Code Diagrams in adoc.
|
||||
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
use volta for npm vesion manager
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
```shell
|
||||
curl https://get.volta.sh | bash
|
||||
volta install node@latest
|
||||
```
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
gem install asciidoctor-pdf --pre
|
||||
npm install puppeteer
|
||||
npx puppeteer browsers install chrome
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
run
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
```shell
|
||||
asciidoctor --require ./snippet_to_image.rb --backend pdf chapter_22-formats-whats-important-per-format.adoc -o test.docx
|
||||
```
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
sudo apt install pandoc -y
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
use python instead of ruby
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
python process.py chapter_22-formats-whats-important-per-format.adoc
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
## install d2 for diagrams
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
```shell
|
||||
sudo apt install build-essential
|
||||
curl -fsSL https://d2lang.com/install.sh | sh -s --
|
||||
```
|
||||
|
||||
Codes for themes for d2 diagrams are in https://d2lang.com/tour/themes
|
||||
|
||||
you use them this way
|
||||
|
||||
[d2, format=svg, layout=dagre, theme=0]
|
||||
|
||||
that would be theme neutral.
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
|
||||
73
process.py
Normal file
73
process.py
Normal file
@ -0,0 +1,73 @@
|
||||
import subprocess
|
||||
import tempfile
|
||||
import os
|
||||
import sys
|
||||
import uuid
|
||||
import re
|
||||
|
||||
CAPTURE_AREA = '#captureArea'
|
||||
|
||||
def main(input_file):
|
||||
if not input_file:
|
||||
print("Usage: python3 script.py path/to/document.adoc")
|
||||
sys.exit(1)
|
||||
|
||||
output_directory = os.path.dirname(input_file)
|
||||
output_basename = os.path.splitext(os.path.basename(input_file))[0]
|
||||
output_docx = os.path.join(output_directory, f"{output_basename}.docx")
|
||||
images_directory = "./generated_images"
|
||||
|
||||
# Ensure the images directory exists
|
||||
os.makedirs(images_directory, exist_ok=True)
|
||||
|
||||
# Create a temporary directory
|
||||
with tempfile.TemporaryDirectory() as temp_dir:
|
||||
html_path = os.path.join(temp_dir, f"{output_basename}_temp.html")
|
||||
|
||||
# Convert AsciiDoc to HTML first, handling images next
|
||||
subprocess.run(['asciidoctor', '-b', 'html', '-o', html_path, input_file], check=True)
|
||||
|
||||
# Read the generated HTML
|
||||
with open(html_path, 'r') as file:
|
||||
content = file.read()
|
||||
|
||||
# Modify the content by replacing image placeholders with actual image tags
|
||||
modified_content = replace_images(content, images_directory)
|
||||
|
||||
# Rewrite the modified HTML back to file
|
||||
with open(html_path, 'w') as file:
|
||||
file.write(modified_content)
|
||||
|
||||
# Convert the final HTML to DOCX
|
||||
subprocess.run(['pandoc', '-f', 'html', '-t', 'docx', '-o', output_docx, html_path], check=True)
|
||||
|
||||
print(f"DOCX file created successfully: {output_docx}")
|
||||
|
||||
|
||||
def replace_images(content, image_dir):
|
||||
def replacement(match):
|
||||
html_content = match.group(1).strip()
|
||||
image_id = str(uuid.uuid4())
|
||||
output_path = os.path.join(image_dir, f"{image_id}.png")
|
||||
|
||||
# Prepare the HTML content by wrapping it in an HTML document
|
||||
full_html = f"<html><body>{html_content}</body></html>"
|
||||
|
||||
# Call the Node.js script to convert HTML to an image
|
||||
command = ['node', 'saveAsImage.js', full_html, output_path, CAPTURE_AREA]
|
||||
result = subprocess.run(command, capture_output=True, text=True)
|
||||
|
||||
if result.returncode != 0:
|
||||
print("Failed to generate image:", result.stderr)
|
||||
return "" # Return empty if image generation fails
|
||||
else:
|
||||
# Return the image tag for HTML
|
||||
return f'<img src="{output_path}" alt="Generated Image" style="width:75%;">'
|
||||
|
||||
# Use re.DOTALL to ensure that multiline HTML content is matched correctly
|
||||
# The '?' in '.*?' makes the matching lazy, which helps in matching multiple instances correctly
|
||||
return re.sub(r'<!--image-->(.*?)<!--/image-->', replacement, content, flags=re.DOTALL)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main(sys.argv[1])
|
||||
24
saveAsImage.js
Normal file
24
saveAsImage.js
Normal file
@ -0,0 +1,24 @@
|
||||
const puppeteer = require('puppeteer');
|
||||
|
||||
async function htmlToImage(htmlContent, outputPath, selector) {
|
||||
const browser = await puppeteer.launch();
|
||||
const page = await browser.newPage();
|
||||
await page.setContent(htmlContent, {waitUntil: 'networkidle0'});
|
||||
|
||||
// Ensure the element exists and is visible
|
||||
const element = await page.$(selector);
|
||||
if (element) {
|
||||
// Take a screenshot of the element
|
||||
await element.screenshot({path: outputPath});
|
||||
console.log(`Image saved to ${outputPath}`);
|
||||
} else {
|
||||
console.log('Error: Element not found or not visible.');
|
||||
}
|
||||
|
||||
await browser.close();
|
||||
}
|
||||
|
||||
// Assuming process.argv[2] is your HTML content, and process.argv[3] is the output path, process.argv[4] is the selector
|
||||
const [,, htmlContent, outputPath, selector] = process.argv;
|
||||
|
||||
htmlToImage(htmlContent, outputPath, selector).then(() => console.log(`Screenshot of ${selector} completed.`));
|
||||
42
snippet_to_image.rb
Normal file
42
snippet_to_image.rb
Normal file
@ -0,0 +1,42 @@
|
||||
require 'asciidoctor'
|
||||
require 'asciidoctor-pdf'
|
||||
require 'securerandom'
|
||||
|
||||
class SnippetToImageFilter < Asciidoctor::Extensions::Preprocessor
|
||||
def process(document, reader)
|
||||
new_lines = []
|
||||
image_id = nil
|
||||
capture = false
|
||||
html_content = ""
|
||||
|
||||
reader.lines.each do |line|
|
||||
if line.strip == "<!--image-->"
|
||||
capture = true
|
||||
image_id = SecureRandom.hex(10)
|
||||
next
|
||||
elsif line.strip == "<!--/image-->" && capture
|
||||
output_path = "generated_images/#{image_id}.png"
|
||||
`node saveAsImage.js "#{html_content}" "#{output_path}"`
|
||||
new_lines << "image::#{output_path}[Generated Image, scaledwidth=75%]"
|
||||
capture = false
|
||||
html_content = ""
|
||||
next
|
||||
elsif capture
|
||||
html_content += line
|
||||
else
|
||||
new_lines << line
|
||||
end
|
||||
end
|
||||
|
||||
# Ensure all lines are added if the document doesn't end properly
|
||||
if capture
|
||||
new_lines.concat(html_content.split("\n"))
|
||||
end
|
||||
|
||||
Asciidoctor::PreprocessorReader.new(document, new_lines)
|
||||
end
|
||||
end
|
||||
|
||||
Asciidoctor::Extensions.register do
|
||||
preprocessor SnippetToImageFilter
|
||||
end
|
||||
59
theme/ai.yml
Normal file
59
theme/ai.yml
Normal file
@ -0,0 +1,59 @@
|
||||
extends: default
|
||||
page:
|
||||
layout: portrait
|
||||
margin: [ 0.75in, 0.8in, 0.75in, 0.8in ]
|
||||
size: [5.5in, 8.5in]
|
||||
footer_font_size: 8
|
||||
footer_font_style: italic
|
||||
footer_margin: 0.1in
|
||||
|
||||
base:
|
||||
font_family: Times-Roman
|
||||
font_size: 10
|
||||
line_height: 1.25
|
||||
|
||||
heading1:
|
||||
color: #2e2e2e
|
||||
font_family: Open Sans
|
||||
font_size: 16
|
||||
margin_top: 20
|
||||
margin_bottom: 10
|
||||
|
||||
heading2:
|
||||
color: #2e2e2e
|
||||
font_family: Open Sans
|
||||
font_size: 14
|
||||
margin_top: 15
|
||||
margin_bottom: 10
|
||||
|
||||
heading3:
|
||||
color: #2e2e2e
|
||||
font_family: Open Sans
|
||||
font_size: 12
|
||||
margin_top: 10
|
||||
margin_bottom: 10
|
||||
|
||||
admonition:
|
||||
border_color: #cccccc
|
||||
border_width: 1
|
||||
background_color: #f8f8f8
|
||||
padding: 10
|
||||
|
||||
list:
|
||||
marker_color: #2e2e2e
|
||||
|
||||
image:
|
||||
fit: contain
|
||||
position: center
|
||||
|
||||
table:
|
||||
border_width: 1
|
||||
border_color: #cccccc
|
||||
background_color_header: #2e2e2e
|
||||
background_color_alternate_rows: #f8f8f8
|
||||
width: 100%
|
||||
margin_top: 10
|
||||
margin_bottom: 10
|
||||
font_size: 10
|
||||
header_font_color: white
|
||||
header_font_size: 12
|
||||
47
theme/basic-theme.yml
Normal file
47
theme/basic-theme.yml
Normal file
@ -0,0 +1,47 @@
|
||||
#extends: base
|
||||
# extends: default
|
||||
extends: default
|
||||
page:
|
||||
layout: portrait
|
||||
margin: [ 0.75in, 0.8in, 0.75in, 0.8in ]
|
||||
size: [5.5in, 8.5in]
|
||||
base:
|
||||
background-color: #FFFFFF
|
||||
font-color: #333333
|
||||
font-family: Times-Roman
|
||||
font-size: 9
|
||||
line-height-length: 14.5
|
||||
line-height: $base-line-height-length / $base-font-size
|
||||
vertical-spacing: $base-line-height-length
|
||||
heading:
|
||||
font-color: #262626
|
||||
font-size: 12
|
||||
font-style: bold
|
||||
line-height: 1.2
|
||||
chapter_break_before: false
|
||||
margin-bottom: $vertical-spacing + 2
|
||||
link:
|
||||
font-color: #002FA7
|
||||
outline-list:
|
||||
indent: $base-font-size * 1.5
|
||||
footer:
|
||||
height: $base-line-height-length * 2.5
|
||||
line-height: 1
|
||||
recto:
|
||||
right:
|
||||
content: '{page-number}'
|
||||
verso:
|
||||
left:
|
||||
content: $footer-recto-right-content
|
||||
|
||||
example:
|
||||
# border_color: $base_border_color
|
||||
border_color: #000000
|
||||
border_radius: $base_border_radius
|
||||
border_width: 0.75
|
||||
background_color: #eeeeee
|
||||
# FIXME reenable padding bottom once margin collapsing is implemented
|
||||
padding: [ $vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm ]
|
||||
|
||||
quote:
|
||||
font-size: 11
|
||||
37
theme/chronicles-theme.yml
Normal file
37
theme/chronicles-theme.yml
Normal file
@ -0,0 +1,37 @@
|
||||
extends: default
|
||||
page:
|
||||
layout: portrait
|
||||
margin: [ 0.75in, 0.8in, 0.75in, 0.8in ]
|
||||
size: [5.5in, 8.5in]
|
||||
role:
|
||||
love:
|
||||
font-color: E0245E
|
||||
wild:
|
||||
font-color: 222222
|
||||
text-transform: uppercase
|
||||
font-style: italic
|
||||
background-color: BCD637
|
||||
border-offset: 1.5
|
||||
header:
|
||||
font_color: 999999
|
||||
height: 0.5in
|
||||
recto:
|
||||
columns: "<40% =20% >40%"
|
||||
right:
|
||||
content: '_{organization}_'
|
||||
center:
|
||||
content: image:sample-logo.jpg[pdfwidth=0.25in]
|
||||
verso:
|
||||
columns: $header_recto_columns
|
||||
left:
|
||||
content: $header_recto_right_content
|
||||
center:
|
||||
content: $header_recto_center_content
|
||||
footer:
|
||||
height: 0.45in
|
||||
recto:
|
||||
right:
|
||||
content: '{section-or-chapter-title} | {page-number}'
|
||||
verso:
|
||||
left:
|
||||
content: '{page-number} | {chapter-title}'
|
||||
Loading…
x
Reference in New Issue
Block a user