-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
288 changed files
with
86,836 additions
and
0 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,316 @@ | ||
<!DOCTYPE HTML> | ||
<html lang="en" class="light sidebar-visible" dir="ltr"> | ||
<head prefix="og: http://ogp.me/ns#"> | ||
<!-- Book generated using mdBook --> | ||
<meta charset="UTF-8"> | ||
<title>Getting Started - The Veryl Hardware Description Language</title> | ||
|
||
|
||
<!-- Custom HTML head --> | ||
<!-- Google tag (gtag.js) --> | ||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-NXW2P6CCF3"></script> | ||
<script> | ||
window.dataLayer = window.dataLayer || []; | ||
function gtag(){dataLayer.push(arguments);} | ||
gtag('js', new Date()); | ||
|
||
gtag('config', 'G-NXW2P6CCF3'); | ||
</script> | ||
|
||
<script> | ||
(function () { | ||
// See these pages for details: | ||
// https://developers.google.com/search/docs/crawling-indexing/consolidate-duplicate-urls | ||
// https://developers.google.com/search/docs/crawling-indexing/javascript/javascript-seo-basics | ||
|
||
function gen_canonical_href(lang) { | ||
let base = "https://doc.veryl-lang.org/book"; | ||
let canonical_href; | ||
if (lang == "en") { | ||
canonical_href = `${base}/03_getting_started.md`; | ||
} else { | ||
canonical_href = `${base}/${lang}/03_getting_started.md`; | ||
} | ||
canonical_href = canonical_href.slice(0, -"md".length) + "html"; | ||
if (canonical_href.endsWith("/index.html")) { | ||
canonical_href = canonical_href.slice(0, -"index.html".length); | ||
} | ||
return canonical_href; | ||
} | ||
|
||
const canonical_href = gen_canonical_href("en"); | ||
|
||
let link = document.createElement("link"); | ||
link.rel = "canonical"; | ||
link.href = canonical_href; | ||
document.head.appendChild(link); | ||
|
||
const langs = ["en", "ja"]; | ||
for (const lang of langs) { | ||
const canonical_href = gen_canonical_href(lang); | ||
|
||
let link = document.createElement("link"); | ||
link.rel = "alternate"; | ||
link.hreflang = lang; | ||
link.href = canonical_href; | ||
document.head.appendChild(link); | ||
} | ||
})() | ||
</script> | ||
|
||
<meta property="og:url" content="https://github.com/veryl-lang/veryl" /> | ||
<meta property="og:title" content="Veryl: A Modern Hardware Description Language" /> | ||
<meta property="og:description" content="Veryl is a hardware description language which is designed as a SystemVerilog alternative." /> | ||
<meta property="og:image" content="https://github.com/veryl-lang/veryl/raw/master/support/logo/veryl_ogp.png" /> | ||
|
||
<meta name="description" content=""> | ||
<meta name="viewport" content="width=device-width, initial-scale=1"> | ||
<meta name="theme-color" content="#ffffff"> | ||
|
||
<link rel="shortcut icon" href="favicon.png"> | ||
<link rel="stylesheet" href="css/variables.css"> | ||
<link rel="stylesheet" href="css/general.css"> | ||
<link rel="stylesheet" href="css/chrome.css"> | ||
<link rel="stylesheet" href="css/print.css" media="print"> | ||
|
||
<!-- Fonts --> | ||
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css"> | ||
<link rel="stylesheet" href="fonts/fonts.css"> | ||
|
||
<!-- Highlight.js Stylesheets --> | ||
<link rel="stylesheet" href="highlight.css"> | ||
<link rel="stylesheet" href="tomorrow-night.css"> | ||
<link rel="stylesheet" href="ayu-highlight.css"> | ||
|
||
<!-- Custom theme stylesheets --> | ||
<link rel="stylesheet" href="theme/css/language-picker.css"> | ||
|
||
|
||
<!-- Provide site root to javascript --> | ||
<script> | ||
var path_to_root = ""; | ||
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light"; | ||
</script> | ||
<!-- Start loading toc.js asap --> | ||
<script src="toc.js"></script> | ||
</head> | ||
<body> | ||
<div id="body-container"> | ||
<!-- Work around some values being stored in localStorage wrapped in quotes --> | ||
<script> | ||
try { | ||
var theme = localStorage.getItem('mdbook-theme'); | ||
var sidebar = localStorage.getItem('mdbook-sidebar'); | ||
|
||
if (theme.startsWith('"') && theme.endsWith('"')) { | ||
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); | ||
} | ||
|
||
if (sidebar.startsWith('"') && sidebar.endsWith('"')) { | ||
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); | ||
} | ||
} catch (e) { } | ||
</script> | ||
|
||
<!-- Set the theme before any content is loaded, prevents flash --> | ||
<script> | ||
var theme; | ||
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } | ||
if (theme === null || theme === undefined) { theme = default_theme; } | ||
const html = document.documentElement; | ||
html.classList.remove('light') | ||
html.classList.add(theme); | ||
html.classList.add("js"); | ||
</script> | ||
|
||
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> | ||
|
||
<!-- Hide / unhide sidebar before it is displayed --> | ||
<script> | ||
var sidebar = null; | ||
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); | ||
if (document.body.clientWidth >= 1080) { | ||
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } | ||
sidebar = sidebar || 'visible'; | ||
} else { | ||
sidebar = 'hidden'; | ||
} | ||
sidebar_toggle.checked = sidebar === 'visible'; | ||
html.classList.remove('sidebar-visible'); | ||
html.classList.add("sidebar-" + sidebar); | ||
</script> | ||
|
||
<nav id="sidebar" class="sidebar" aria-label="Table of contents"> | ||
<!-- populated by js --> | ||
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox> | ||
<noscript> | ||
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe> | ||
</noscript> | ||
<div id="sidebar-resize-handle" class="sidebar-resize-handle"> | ||
<div class="sidebar-resize-indicator"></div> | ||
</div> | ||
</nav> | ||
|
||
<div id="page-wrapper" class="page-wrapper"> | ||
|
||
<div class="page"> | ||
<div id="menu-bar-hover-placeholder"></div> | ||
<div id="menu-bar" class="menu-bar sticky"> | ||
<div class="left-buttons"> | ||
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> | ||
<i class="fa fa-bars"></i> | ||
</label> | ||
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> | ||
<i class="fa fa-paint-brush"></i> | ||
</button> | ||
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu"> | ||
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li> | ||
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li> | ||
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li> | ||
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li> | ||
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li> | ||
</ul> | ||
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar"> | ||
<i class="fa fa-search"></i> | ||
</button> | ||
</div> | ||
|
||
<h1 class="menu-title">The Veryl Hardware Description Language</h1> | ||
|
||
<div class="right-buttons"> | ||
<button id="language-toggle" class="icon-button" type="button" | ||
title="Change language" aria-label="Change language" | ||
aria-haspopup="true" aria-expanded="false" | ||
aria-controls="language-list"> | ||
<i class="fa fa-globe"></i> | ||
</button> | ||
<ul id="language-list" class="theme-popup" aria-label="Languages" role="menu"> | ||
<li role="none"><button role="menuitem" class="theme"> | ||
<a id="en">English</a> | ||
</button></li> | ||
<li role="none"><button role="menuitem" class="theme"> | ||
<a id="ja">日本語</a> | ||
</button></li> | ||
</ul> | ||
|
||
<script> | ||
let langToggle = document.getElementById("language-toggle"); | ||
let langList = document.getElementById("language-list"); | ||
langToggle.addEventListener("click", (event) => { | ||
langList.style.display = langList.style.display == "block" ? "none" : "block"; | ||
}); | ||
let selectedLang = document.getElementById("en"); | ||
if (selectedLang) { | ||
selectedLang.parentNode.classList.add("theme-selected"); | ||
} | ||
|
||
// The path to the root, taking the current | ||
// language into account. | ||
let full_path_to_root = ""; | ||
// The page path (mdbook only gives us | ||
// access to the path to the Markdown file). | ||
let path = "03_getting_started.md".replace(/\.md$/, ".html"); | ||
for (let lang of langList.querySelectorAll("a")) { | ||
if (lang.id == "en") { | ||
lang.href = `${full_path_to_root}${path}`; | ||
} else { | ||
lang.href = `${full_path_to_root}${lang.id}/${path}`; | ||
} | ||
} | ||
</script> | ||
|
||
<a href="print.html" title="Print this book" aria-label="Print this book"> | ||
<i id="print-button" class="fa fa-print"></i> | ||
</a> | ||
|
||
</div> | ||
</div> | ||
|
||
<div id="search-wrapper" class="hidden"> | ||
<form id="searchbar-outer" class="searchbar-outer"> | ||
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header"> | ||
</form> | ||
<div id="searchresults-outer" class="searchresults-outer hidden"> | ||
<div id="searchresults-header" class="searchresults-header"></div> | ||
<ul id="searchresults"> | ||
</ul> | ||
</div> | ||
</div> | ||
|
||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> | ||
<script> | ||
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); | ||
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); | ||
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { | ||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); | ||
}); | ||
</script> | ||
|
||
<div id="content" class="content"> | ||
<main> | ||
<h1 id="getting-started"><a class="header" href="#getting-started">Getting Started</a></h1> | ||
<p>Let’s start to use Veryl. In this section, we will install Veryl, create an example project, and build it.</p> | ||
|
||
</main> | ||
|
||
<nav class="nav-wrapper" aria-label="Page navigation"> | ||
<!-- Mobile navigation buttons --> | ||
<a rel="prev" href="02_features.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | ||
<i class="fa fa-angle-left"></i> | ||
</a> | ||
|
||
<a rel="next prefetch" href="03_getting_started/01_installation.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> | ||
<i class="fa fa-angle-right"></i> | ||
</a> | ||
|
||
<div style="clear: both"></div> | ||
</nav> | ||
</div> | ||
</div> | ||
|
||
<nav class="nav-wide-wrapper" aria-label="Page navigation"> | ||
<a rel="prev" href="02_features.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> | ||
<i class="fa fa-angle-left"></i> | ||
</a> | ||
|
||
<a rel="next prefetch" href="03_getting_started/01_installation.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right"> | ||
<i class="fa fa-angle-right"></i> | ||
</a> | ||
</nav> | ||
|
||
</div> | ||
|
||
|
||
|
||
|
||
<script> | ||
window.playground_copyable = true; | ||
</script> | ||
|
||
<script src="ace.js"></script> | ||
<script src="editor.js"></script> | ||
<script src="mode-rust.js"></script> | ||
<script src="theme-dawn.js"></script> | ||
<script src="theme-tomorrow_night.js"></script> | ||
|
||
<script src="elasticlunr.min.js"></script> | ||
<script src="mark.min.js"></script> | ||
<script src="searcher.js"></script> | ||
|
||
<script src="clipboard.min.js"></script> | ||
<script src="highlight.js"></script> | ||
<script src="book.js"></script> | ||
<script type="module"> | ||
import init, {build, format} from "https://doc.veryl-lang.org/nightly/playground/pkg/veryl_wasm.js"; | ||
init().then(() => {}); | ||
window.build = build; | ||
</script> | ||
|
||
<!-- Custom JS scripts --> | ||
<script src="mode-veryl.js"></script> | ||
<script src="editor.js"></script> | ||
|
||
|
||
</div> | ||
</body> | ||
</html> |
Oops, something went wrong.