Skip to content

Commit

Permalink
we should be able to publish the page from main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
@cubbimew
cubbimew committed May 12, 2024
1 parent 019ec5d commit 5ff9218
Show file tree
Hide file tree
Showing 15 changed files with 1,287 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/jekyll-gh-pages.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ name: Deploy Jekyll with GitHub Pages dependencies preinstalled
on:
# Runs on pushes targeting the default branch
push:
branches: ["gh-pages"]
branches: ["master"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand Down
2 changes: 2 additions & 0 deletions _config.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include: [CppCoreGuidelines.md]
exclude: [docs, talks, Gemfile, params.json]
65 changes: 65 additions & 0 deletions _includes/head.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<head>
<link href="http://gmpg.org/xfn/11" rel="profile">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta http-equiv="content-type" content="text/html; charset=utf-8">

<!-- Enable responsiveness on mobile devices-->
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">

<title>C++ Core Guidelines</title>

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/styles/github.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/highlight.min.js"></script>

<!-- CSS, could be merged and minified for improved loading speed -->
<link rel="stylesheet" href="{{ site.baseurl }}/public/css/poole.css">
<link rel="stylesheet" href="{{ site.baseurl }}/public/css/hyde.css">
<link rel="stylesheet" href="{{ site.baseurl }}/public/css/custom.css">

<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400italic,700|Abril+Fatface|Roboto+Mono">
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">


<!-- Include jquery.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>


<!-- make sure you include the latest version -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/3.2.2/anchor.min.js"></script>

<!-- No highlight on page load -->
<script type="text/javascript">
$( document ).ready(function() {
$("code").addClass("no-highlight");
});
</script>

<!-- AnchoJs links next to headers-->
<script type="text/javascript">
$( document ).ready(function () {
anchors.add("h1, h2, h3");
});
</script>

<!-- hack to toggle highlight on or off -->
<script type="text/javascript">
function stripSpans(i, spanTag) {
var text = spanTag.textContent || spanTag.innerText;
var node = document.createTextNode(text);
spanTag.parentNode.replaceChild(node, spanTag);
}
$(function() {
$("#hl_button")
.click(function( event ) {
$("pre code").toggleClass("cpp");
$("pre code").toggleClass("hljs");
$("pre code").toggleClass("no-highlight");
$("pre code").each(function(i, block) {
hljs.highlightBlock(block);
});
$("code.no-highlight").find("span").each(stripSpans);
});
});
</script>
</head>

70 changes: 70 additions & 0 deletions _includes/sidebar.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<div class="sidebar">
<div class="container sidebar-sticky">
<div class="sidebar-about">
<img src="cpp_core_guidelines_16b.png"/>
<!--
<h3>
<!- -<a href="{{ site.baseurl }}">- ->
<a href="https://github.com/isocpp/CppCoreGuidelines">
C++ Core Guidelines
</a>
</h3>
-->
</div>
<nav class="sidebar-nav">
<small>
{% if page.name == "CppCoreGuidelines.md" %}

<div class="switch">
<input class="tgl tgl-cpp" id="hl_button" type="checkbox"/>
<label class="tgl-btn" data-tg-off="Turn ON syntax highlighting" data-tg-on="Turn OFF syntax highlighting" for="hl_button"></label>
</div>
<!-- Items have to be added manually until for now -->
<b><a class="sidebar-nav-item active" href="#main">Top</a></b>

<a class="sidebar-nav-item active" href="#S-introduction">In: Introduction</a>
<a class="sidebar-nav-item active" href="#S-philosophy">P: Philosophy</a>
<a class="sidebar-nav-item active" href="#S-interfaces">I: Interfaces</a>
<a class="sidebar-nav-item active" href="#S-functions">F: Functions</a>
<a class="sidebar-nav-item active" href="#S-class">C: Classes and class hierarchies</a>
<a class="sidebar-nav-item active" href="#S-enum">Enum: Enumerations</a>
<a class="sidebar-nav-item active" href="#S-resource">R: Resource management</a>
<a class="sidebar-nav-item active" href="#S-expr">ES: Expressions and statements</a>
<a class="sidebar-nav-item active" href="#S-performance">Per: Performance</a>
<a class="sidebar-nav-item active" href="#S-concurrency">CP: Concurrency</a>
<a class="sidebar-nav-item active" href="#S-errors">E: Error handling</a>
<a class="sidebar-nav-item active" href="#S-const">Con: Constants and immutability</a>
<a class="sidebar-nav-item active" href="#S-templates">T: Templates and generic programming</a>
<a class="sidebar-nav-item active" href="#S-cpl">CPL: C-style programming</a>
<a class="sidebar-nav-item active" href="#S-source">SF: Source files</a>
<a class="sidebar-nav-item active" href="#S-stdlib">SL: The Standard library</a>
<br/>
<a class="sidebar-nav-item active" href="#S-A">A: Architectural Ideas</a>
<a class="sidebar-nav-item active" href="#S-not">NR: Non-Rules and myths</a>
<a class="sidebar-nav-item active" href="#S-references">RF: References</a>
<a class="sidebar-nav-item active" href="#S-profile">Pro: Profiles</a>
<a class="sidebar-nav-item active" href="#S-gsl">GSL: Guideline support library</a>
<a class="sidebar-nav-item active" href="#S-naming">NL: Naming and layout</a>
<a class="sidebar-nav-item active" href="#S-faq">FAQ: Frequently asked questions</a>
<a class="sidebar-nav-item active" href="#S-libraries">Appendix A: Libraries</a>
<a class="sidebar-nav-item active" href="#S-modernizing">Appendix B: Modernizing code</a>
<a class="sidebar-nav-item active" href="#S-discussion">Appendix C: Discussion</a>
<a class="sidebar-nav-item active" href="#S-tools">Appendix D: Tools support</a>
<a class="sidebar-nav-item active" href="#S-glossary">Glossary</a>
<a class="sidebar-nav-item active" href="#S-unclassified">To-do: Unclassified proto-rules</a>
{% else %}

<a class="sidebar-nav-item active" href="CppCoreGuidelines.html">Read the C++ Core Guidelines</a>
<br/>
<a class="sidebar-nav-item active" href="index.html">View project README</a>
<a class="sidebar-nav-item active" href="CONTRIBUTING.md">View project Contributing</a>
<a class="sidebar-nav-item active" href="LICENSE">View project License</a>
{% endif %}

</small>

</nav>

<!-- <p>Generated {{ site.time | date: '%Y-%m-%d' }}.</p> -->
</div>
</div>
17 changes: 17 additions & 0 deletions _layouts/default.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!DOCTYPE html>
<html lang="en-us">

{% include head.html %}

<body>

{% include sidebar.html %}

<div class="banner"><a href="https://github.com/isocpp/CppCoreGuidelines"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/365986a132ccd6a44c23a9169022c0b5c890c387/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"></a></div>

<div class="content container">
{{ content }}
</div>

</body>
</html>
Binary file added cpp_core_guidelines_16b.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
layout: default
---

<p class="sidebar-about">This site is copy of the C++ Core Guidelines rendered for easier browsing. As the text on this page is integrated manually
you should refer to the <a href="https://github.com/isocpp/CppCoreGuidelines">C++ Core Guidelines repo</a> for the most up-to-date version.
</p>

<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<!--
<section id="downloads">
<a class="zip_download_link" href="https://github.com/tkruse/CppCoreGuidelines/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/tkruse/CppCoreGuidelines/tarball/master">Download this project as a tar.gz file</a>
</section>
-->
</header>
</div>

{% capture readme %}{% include_relative README.md %}{% endcapture %}
{{ readme | markdownify }}
1 change: 1 addition & 0 deletions params.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"name":"Cppcoreguidelines","tagline":"The C++ Core Guidelines are a set of tried-and-true guidelines, rules, and best practices about coding in C++","body":"# C++ Core Guidelines\r\n\r\n>\"Within C++ is a smaller, simpler, safer language struggling to get out.\" \r\n>-- <cite>Bjarne Stroustrup</cite>\r\n\r\nThe C++ Core Guidelines are a collaborative effort led by Bjarne Stroustrup, much like the C++ language itself. They are the result of many \r\nperson-years of discussion and design across a number of organizations. Their design encourages general applicability and broad adoption but \r\nthey can be freely copied and modified to meet your organization's needs. \r\n\r\nThe aim of the guidelines is to help people to use modern C++ effectively. By \"modern C++\" we mean C++11 and C++14 (and soon C++17). In other \r\nwords, what would you like your code to look like in 5 years' time, given that you can start now? In 10 years' time?\r\n\r\nThe guidelines are focused on relatively higher-level issues, such as interfaces, resource management, memory management, and concurrency. Such \r\nrules affect application architecture and library design. Following the rules will lead to code that is statically type safe, has no resource \r\nleaks, and catches many more programming logic errors than is common in code today. And it will run fast - you can afford to do things right.\r\n\r\nWe are less concerned with low-level issues, such as naming conventions and indentation style. However, no topic that can help a programmer is \r\nout of bounds.\r\n\r\nOur initial set of rules emphasize safety (of various forms) and simplicity. They may very well be too strict. We expect to have to introduce \r\nmore exceptions to better accommodate real-world needs. We also need more rules.\r\n\r\nYou will find some of the rules contrary to your expectations or even contrary to your experience. If we haven't suggested you change your \r\ncoding style in any way, we have failed! Please try to verify or disprove rules! In particular, we'd really like to have some of our rules \r\nbacked up with measurements or better examples.\r\n\r\nYou will find some of the rules obvious or even trivial. Please remember that one purpose of a guideline is to help someone who is less \r\nexperienced or coming from a different background or language to get up to speed.\r\n\r\nThe rules are designed to be supported by an analysis tool. Violations of rules will be flagged with references (or links) to the relevant rule. \r\nWe do not expect you to memorize all the rules before trying to write code.\r\n\r\nThe rules are meant for gradual introduction into a code base. We plan to build tools for that and hope others will too.\r\n\r\nComments and suggestions for improvements are most welcome. We plan to modify and extend this document as our understanding improves and the \r\nlanguage and the set of available libraries improve.\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
Loading

0 comments on commit 5ff9218

Please sign in to comment.