Skip to content

Commit

Permalink
Dev Site Update. [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed May 8, 2024
1 parent dc84c62 commit a65779d
Show file tree
Hide file tree
Showing 57 changed files with 129 additions and 3,559 deletions.
97 changes: 1 addition & 96 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="MarkBind 5.5.2">
<meta name="viewport" content="width=device-width, initial-scale=1"><title>MarkBind - Page not found</title> <link rel="stylesheet" href="/devdocs/markbind/css/bootstrap.min.css"><link rel="stylesheet" href="/devdocs/markbind/css/codeblock-light.min.css"><link rel="stylesheet" href="/devdocs/markbind/css/markbind.min.css"><link rel="stylesheet" href="/devdocs/plugins/web3Form/web-3-form.css"><link rel="stylesheet" href="/devdocs/plugins/dataTable/datatables.min.css"><link rel="stylesheet" href="/devdocs/plugins/dataTable/datatables-additional.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-anchors/markbind-plugin-anchors.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-tree/markbind-plugin-tree.css"><link rel="icon" href="/devdocs/favicon.ico"></head>
<meta name="viewport" content="width=device-width, initial-scale=1"><title>MarkBind - Page not found</title> <link rel="stylesheet" href="/devdocs/markbind/css/bootstrap.min.css"><link rel="stylesheet" href="/devdocs/markbind/css/codeblock-light.min.css"><link rel="stylesheet" href="/devdocs/markbind/css/markbind.min.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-anchors/markbind-plugin-anchors.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-tree/markbind-plugin-tree.css"><link rel="icon" href="/devdocs/favicon.ico"></head>
<script>
const baseUrl = '/devdocs'
</script>
Expand All @@ -18,50 +18,6 @@
<script>
MarkBind.setupWithSearch()
</script>
<script>
function toggleCodeBlockWrap(element) {
const pre = element.parentElement.parentElement;
const classList = pre.querySelector('code').classList;
if (classList.contains('wrap')) {
classList.remove('wrap');
} else {
classList.add('wrap')
}
}
</script>

<script>
function submitForm(element) {
event.preventDefault();
const formData = new FormData(element);
const formProps = Object.fromEntries(formData);
const json = JSON.stringify(formProps);
const submitButton = element.querySelector('button[type="submit"]');
const submitButtonText = submitButton.innerText;
submitButton.innerText = 'Please wait...'
fetch('https://api.web3forms.com/submit', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Accept': 'application/json'
},
body: json,
})
.then(async (response) => {
if (response.status == 200) {
alert('Form submitted! Thank you for your response');
} else {
alert('Error submitting form! Please try again later.');
}
})
.catch(error => {
alert('Error submitting form! Please try again later.');
})
.finally(() => {
submitButton.innerText = submitButtonText;
})
}
</script>
<script>
function copyCodeBlock(element) {
const pre = element.parentElement.parentElement;
Expand All @@ -77,55 +33,4 @@
document.body.removeChild(textElement);
}
</script>
<script src="/devdocs/plugins/dataTable/datatables.min.js"></script>

<script>
function getTableOptions(el) {
const options = {};
if ($(el).hasClass('sortable-table')) {
options.searching = false;
options.paging = false;
options.info = false;
} else if ($(el).hasClass('searchable-table')) {
options.ordering = false;
options.paging = false;
options.info = false;
options.dom = '<"row"<"col-sm-12"f>>' + '<"row"<"col-sm-12"t>>';
} else if ($(el).hasClass('sortable-searchable-table')) {
options.paging = false;
options.info = false;
options.dom = '<"row"<"col-sm-12"f>>' + '<"row"<"col-sm-12"t>>';
}
return options;
}

Vue.directive('datatable', {
inserted: function(el, binding) {
const options = binding.value || {};
const tableOptions = getTableOptions(el);
$(el).DataTable({ ...tableOptions, ...options });
}
});

document.addEventListener('DOMContentLoaded', function() {
$('table.sortable-table, table.searchable-table, table.sortable-searchable-table').each(function() {
const options = getTableOptions(this);
$(this).DataTable(options);
});
});
</script>

<script type="module">
import mermaid from 'https://unpkg.com/mermaid@10/dist/mermaid.esm.min.mjs';
document.addEventListener('DOMContentLoaded', () => {
mermaid.initialize({});
Vue.directive('mermaid', {
inserted: function(el) {
mermaid.run({
nodes: [el]
});
}
});
});
</script>
</html>
99 changes: 2 additions & 97 deletions about.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion about.page-vue-render.js
View file

Large diffs are not rendered by default.

99 changes: 2 additions & 97 deletions devGuide/bootcamp/contributeToDocs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="MarkBind 5.5.2">
<meta name="viewport" content="width=device-width, initial-scale=1"><title>MarkBind - Contribute to Documentation</title> <link rel="stylesheet" href="/devdocs/markbind/css/bootstrap.min.css"> <link rel="stylesheet" href="/devdocs/markbind/fontawesome/css/all.min.css"> <link rel="stylesheet" href="/devdocs/markbind/glyphicons/css/bootstrap-glyphicons.min.css"><link rel="stylesheet" href="/devdocs/markbind/css/codeblock-light.min.css"><link rel="stylesheet" href="/devdocs/markbind/css/markbind.min.css"><link rel="stylesheet" href="/devdocs/plugins/web3Form/web-3-form.css"><link rel="stylesheet" href="/devdocs/plugins/dataTable/datatables.min.css"><link rel="stylesheet" href="/devdocs/plugins/dataTable/datatables-additional.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-anchors/markbind-plugin-anchors.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-tree/markbind-plugin-tree.css">
<meta name="viewport" content="width=device-width, initial-scale=1"><title>MarkBind - Contribute to Documentation</title> <link rel="stylesheet" href="/devdocs/markbind/css/bootstrap.min.css"> <link rel="stylesheet" href="/devdocs/markbind/fontawesome/css/all.min.css"> <link rel="stylesheet" href="/devdocs/markbind/glyphicons/css/bootstrap-glyphicons.min.css"><link rel="stylesheet" href="/devdocs/markbind/css/codeblock-light.min.css"><link rel="stylesheet" href="/devdocs/markbind/css/markbind.min.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-anchors/markbind-plugin-anchors.css"><link rel="stylesheet" href="/devdocs/plugins/markbind-plugin-tree/markbind-plugin-tree.css">

<link rel="stylesheet" href="/devdocs/css/main.css">
<link rel="icon" href="/devdocs/favicon.ico"></head>
Expand Down Expand Up @@ -33,7 +33,7 @@
Now, you can make a pull request targeting the <code class="hljs inline no-lang">master</code> branch of the MarkBind repository.</p> <div id="pr-steps"><ol><li>Fill in the pull request template.</li> <li>Wait for the CI checks to pass.
<ol><li>For first-time contributors, you may need to wait for the MarkBind team to approve your PR before the CI checks can run.</li></ol></li> <li>Verify that the PR preview is working.
<ol><li>The PR preview is generated by netlify/markbind-master/deploy-preview.</li> <li>You can find the link to the PR preview in the checks section of the PR. <span class="image-wrapper"><img src="/devdocs/images/bootcamp/live_preview.png" alt="PR Checks Section" width="920" height="" loading="eager" class="img-fluid rounded"> <span class="image-caption"></span></span></li> <li>Open the link to the PR preview and ensure that your changes are reflected in the rendered site</li></ol></li> <li>Follow up with PR reviews and make changes as requested.</li></ol></div> <p>Since this is a hypothetical change, you do not need to raise a PR. You can refer to PR <a href="https://github.com/MarkBind/markbind/pull/1924">#1924</a> for an example.</p> <div class="alert box-container border-danger alert-border-left" data-v-6607c59e><!----> <div class="header-and-body" data-v-6607c59e><!----> <div class="box-body-wrapper" data-v-6607c59e><div class="icon-wrapper text-danger" data-v-6607c59e><i class="fas fa-flag" data-v-6607c59e></i></div> <!----> <div class="contents" data-v-6607c59e><p data-v-6607c59e><strong data-v-6607c59e>Checkpoint</strong></p> <p data-v-6607c59e>For <span class="underline" data-v-6607c59e>actual</span> documentation changes, check that the following are true:</p> <ul class="contains-task-list" data-v-6607c59e><li class="task-list-item enabled" data-v-6607c59e><input type="checkbox" class="task-list-item-checkbox" data-v-6607c59e> The PR template has been filled in</li> <li class="task-list-item enabled" data-v-6607c59e><input type="checkbox" class="task-list-item-checkbox" data-v-6607c59e> The PR preview is working</li></ul></div> <!----></div></div></div> <h2 id="summary">Summary<a href="#summary" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>In this task, you have learned how to make documentation changes to MarkBind!</p> <p>While documentation changes are not as exciting as code changes, they are still important. In particular, our documentation is generated by MarkBind itself, utilizing the same features that we are documenting. This means that our documentation is a great place to discover and analyze how MarkBind is used!</p> <p>Here are some additional tasks for you to try out:</p> <ul class="contains-task-list"><li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Review a real documentation change (e.g <a href="https://github.com/MarkBind/markbind/issues/1772">issue #1772</a> was resolved in <a href="https://github.com/MarkBind/markbind/pull/1924">PR #1924</a> to improve the user guide)</li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Check if there are <a href="https://github.com/MarkBind/markbind/issues?q=is%3Aopen+label%3A%22a-Documentation+%F0%9F%93%9D%22+sort%3Aupdated-desc">existing issues</a> tagged with the <code class="hljs inline no-lang">a-Documentation</code> label
<ul class="contains-task-list"><li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> If there are, try to resolve them!</li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> If there are not, raise an issue when you discover a documentation bug or improvement (e.g make this bootcamp documentation better)!</li></ul></li></ul> <p>When you are ready, move on to learn how to squash some bugs!</p> <div class="clearfix"><p><span class="float-start"><a href="/devdocs/devGuide/bootcamp/exploreMarkBind.html" class="btn btn-light"><span><span aria-hidden="true" class="far fa-arrow-alt-circle-left"></span> <span>Explore MarkBind as a User</span></span></a></span></p> <p><span class="float-end"><a href="/devdocs/devGuide/bootcamp/fixABug.html" class="btn btn-light"><span><span>Fix a Bug</span> <span aria-hidden="true" class="far fa-arrow-alt-circle-right"></span></span></a></span></p></div> <br></div> <nav id="page-nav" data-v-e6005420><div class="nav-component slim-scroll" data-v-e6005420><nav id="mb-page-nav" class="nav nav-pills flex-column my-0 small no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#contribute-to-documentation" data-v-e6005420>Contribute to Documentation‎</a> <nav class="nav nav-pills flex-column my-0 nested no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#tldr" data-v-e6005420>TLDR‎</a> <a class="nav-link py-1" href="#reviewing-markbind-documentation" data-v-e6005420>Reviewing MarkBind Documentation‎</a> <a class="nav-link py-1" href="#make-modifications-to-the-documentation" data-v-e6005420>Make Modifications to the Documentation‎</a> <a class="nav-link py-1" href="#make-a-pull-request-and-amp-verify-the-pr-preview" data-v-e6005420>Make a Pull Request &amp; Verify the PR Preview‎</a> <a class="nav-link py-1" href="#summary" data-v-e6005420>Summary‎</a></nav> <!----></nav></div> <!----></nav> <div aria-hidden="true" class="scroll-top-button fa-lg d-print-none" style="display:none;bottom:2%;right:2%;position:fixed;"><i class="fas fa-arrow-circle-up"></i></div></div> <div><footer><div class="text-center"><small>[Generated by <a href="https://markbind.org/">MarkBind 5.5.2</a> on Thu, 2 May 2024, 14:00:54 UTC]</small><br> <small>This site is powered by <a href="https://www.netlify.com/">Netlify</a>.</small></div></footer></div></div>
<ul class="contains-task-list"><li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> If there are, try to resolve them!</li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> If there are not, raise an issue when you discover a documentation bug or improvement (e.g make this bootcamp documentation better)!</li></ul></li></ul> <p>When you are ready, move on to learn how to squash some bugs!</p> <div class="clearfix"><p><span class="float-start"><a href="/devdocs/devGuide/bootcamp/exploreMarkBind.html" class="btn btn-light"><span><span aria-hidden="true" class="far fa-arrow-alt-circle-left"></span> <span>Explore MarkBind as a User</span></span></a></span></p> <p><span class="float-end"><a href="/devdocs/devGuide/bootcamp/fixABug.html" class="btn btn-light"><span><span>Fix a Bug</span> <span aria-hidden="true" class="far fa-arrow-alt-circle-right"></span></span></a></span></p></div> <br></div> <nav id="page-nav" data-v-e6005420><div class="nav-component slim-scroll" data-v-e6005420><nav id="mb-page-nav" class="nav nav-pills flex-column my-0 small no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#contribute-to-documentation" data-v-e6005420>Contribute to Documentation‎</a> <nav class="nav nav-pills flex-column my-0 nested no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#tldr" data-v-e6005420>TLDR‎</a> <a class="nav-link py-1" href="#reviewing-markbind-documentation" data-v-e6005420>Reviewing MarkBind Documentation‎</a> <a class="nav-link py-1" href="#make-modifications-to-the-documentation" data-v-e6005420>Make Modifications to the Documentation‎</a> <a class="nav-link py-1" href="#make-a-pull-request-and-amp-verify-the-pr-preview" data-v-e6005420>Make a Pull Request &amp; Verify the PR Preview‎</a> <a class="nav-link py-1" href="#summary" data-v-e6005420>Summary‎</a></nav> <!----></nav></div> <!----></nav> <div aria-hidden="true" class="scroll-top-button fa-lg d-print-none" style="display:none;bottom:2%;right:2%;position:fixed;"><i class="fas fa-arrow-circle-up"></i></div></div> <div><footer><div class="text-center"><small>[Generated by <a href="https://markbind.org/">MarkBind 5.5.2</a> on Wed, 8 May 2024, 6:11:47 UTC]</small><br> <small>This site is powered by <a href="https://www.netlify.com/">Netlify</a>.</small></div></footer></div></div>
</body><script src="/devdocs/markbind/js/bootstrap-utility.min.js"></script>
<script src="/devdocs/markbind/js/polyfill.min.js"></script>
<script src="/devdocs/markbind/js/vue.min.js"></script>
Expand All @@ -42,50 +42,6 @@
<script>
MarkBind.setupWithSearch()
</script>
<script>
function toggleCodeBlockWrap(element) {
const pre = element.parentElement.parentElement;
const classList = pre.querySelector('code').classList;
if (classList.contains('wrap')) {
classList.remove('wrap');
} else {
classList.add('wrap')
}
}
</script>

<script>
function submitForm(element) {
event.preventDefault();
const formData = new FormData(element);
const formProps = Object.fromEntries(formData);
const json = JSON.stringify(formProps);
const submitButton = element.querySelector('button[type="submit"]');
const submitButtonText = submitButton.innerText;
submitButton.innerText = 'Please wait...'
fetch('https://api.web3forms.com/submit', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Accept': 'application/json'
},
body: json,
})
.then(async (response) => {
if (response.status == 200) {
alert('Form submitted! Thank you for your response');
} else {
alert('Error submitting form! Please try again later.');
}
})
.catch(error => {
alert('Error submitting form! Please try again later.');
})
.finally(() => {
submitButton.innerText = submitButtonText;
})
}
</script>
<script>
function copyCodeBlock(element) {
const pre = element.parentElement.parentElement;
Expand All @@ -101,55 +57,4 @@
document.body.removeChild(textElement);
}
</script>
<script src="/devdocs/plugins/dataTable/datatables.min.js"></script>

<script>
function getTableOptions(el) {
const options = {};
if ($(el).hasClass('sortable-table')) {
options.searching = false;
options.paging = false;
options.info = false;
} else if ($(el).hasClass('searchable-table')) {
options.ordering = false;
options.paging = false;
options.info = false;
options.dom = '<"row"<"col-sm-12"f>>' + '<"row"<"col-sm-12"t>>';
} else if ($(el).hasClass('sortable-searchable-table')) {
options.paging = false;
options.info = false;
options.dom = '<"row"<"col-sm-12"f>>' + '<"row"<"col-sm-12"t>>';
}
return options;
}

Vue.directive('datatable', {
inserted: function(el, binding) {
const options = binding.value || {};
const tableOptions = getTableOptions(el);
$(el).DataTable({ ...tableOptions, ...options });
}
});

document.addEventListener('DOMContentLoaded', function() {
$('table.sortable-table, table.searchable-table, table.sortable-searchable-table').each(function() {
const options = getTableOptions(this);
$(this).DataTable(options);
});
});
</script>

<script type="module">
import mermaid from 'https://unpkg.com/mermaid@10/dist/mermaid.esm.min.mjs';
document.addEventListener('DOMContentLoaded', () => {
mermaid.initialize({});
Vue.directive('mermaid', {
inserted: function(el) {
mermaid.run({
nodes: [el]
});
}
});
});
</script>
</html>
Loading

0 comments on commit a65779d

Please sign in to comment.